diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index 56ead0dabd..ea902009d3 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -4671,7 +4671,7 @@ } } }, - "revision": "20250421", + "revision": "20250513", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -5646,7 +5646,23 @@ "enterpriseUpgrade", "educationUpgrade", "education", - "kioskUpgrade" + "kioskUpgrade", + "enterpriseUpgradePerpetual", + "enterpriseUpgradeFixedTerm", + "educationUpgradePerpetual", + "educationUpgradeFixedTerm" + ], + "enumDeprecated": [ + false, + false, + true, + true, + false, + false, + false, + false, + false, + false ], "enumDescriptions": [ "The license type is unknown.", @@ -5654,7 +5670,11 @@ "The device has an annual standalone Chrome Enterprise Upgrade.", "The device has a perpetual standalone Chrome Education Upgrade.", "The device is bundled with a perpetual Chrome Education Upgrade.", - "The device has an annual Kiosk Upgrade." + "The device has an annual Kiosk Upgrade.", + "Indicates that the device is consuming a standalone, perpetual Chrome Enterprise Upgrade, a Chrome Enterprise license.", + "Indicates that the device is consuming a standalone, fixed-term Chrome Enterprise Upgrade, a Chrome Enterprise license.", + "Indicates that the device is consuming a standalone, perpetual Chrome Education Upgrade(AKA Chrome EDU perpetual license).", + "Indicates that the device is consuming a standalone, fixed-term Chrome Education Upgrade(AKA Chrome EDU fixed-term license)." ], "readOnly": true, "type": "string" @@ -6184,6 +6204,7 @@ "REMOTE_POWERWASH", "DEVICE_START_CRD_SESSION", "CAPTURE_LOGS", + "FETCH_CRD_AVAILABILITY_INFO", "FETCH_SUPPORT_PACKET" ], "enumDescriptions": [ @@ -6195,6 +6216,7 @@ "Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!", "Starts a Chrome Remote Desktop session.", "Capture the system logs of a kiosk device. The logs can be downloaded from the downloadUrl link present in `deviceFiles` field of [chromeosdevices](https://developers.google.com/admin-sdk/directory/reference/rest/v1/chromeosdevices)", + "Fetches available type(s) of Chrome Remote Desktop sessions (private or shared) that can be used to remotely connect to the device.", "Fetch support packet from a device remotely. Support packet is a zip archive that contains various system logs and debug data from a ChromeOS device. The support packet can be downloaded from the downloadURL link present in the `deviceFiles` field of [`chromeosdevices`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/chromeosdevices)" ], "type": "string" @@ -6207,7 +6229,7 @@ "id": "DirectoryChromeosdevicesCommandResult", "properties": { "commandResultPayload": { - "description": "The payload for the command result. The following commands respond with a payload: * `DEVICE_START_CRD_SESSION`: Payload is a stringified JSON object in the form: { \"url\": url }. The URL provides a link to the Chrome Remote Desktop session.", + "description": "The payload for the command result. The following commands respond with a payload: * `DEVICE_START_CRD_SESSION`: Payload is a stringified JSON object in the form: { \"url\": url }. The URL provides a link to the Chrome Remote Desktop session. * `FETCH_CRD_AVAILABILITY_INFO`: Payload is a stringified JSON object in the form: { \"deviceIdleTimeInSeconds\": number, \"userSessionType\": string, \"remoteSupportAvailability\": string, \"remoteAccessAvailability\": string }. The \"remoteSupportAvailability\" field is set to \"AVAILABLE\" if `shared` CRD session to the device is available. The \"remoteAccessAvailability\" field is set to \"AVAILABLE\" if `private` CRD session to the device is available.", "type": "string" }, "errorMessage": { @@ -6253,6 +6275,7 @@ "REMOTE_POWERWASH", "DEVICE_START_CRD_SESSION", "CAPTURE_LOGS", + "FETCH_CRD_AVAILABILITY_INFO", "FETCH_SUPPORT_PACKET" ], "enumDescriptions": [ @@ -6264,6 +6287,7 @@ "Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!", "Starts a Chrome Remote Desktop session.", "Capture the system logs of a kiosk device. The logs can be downloaded from the downloadUrl link present in `deviceFiles` field of [chromeosdevices](https://developers.google.com/admin-sdk/directory/reference/rest/v1/chromeosdevices)", + "Fetches available type(s) of Chrome Remote Desktop sessions (private or shared) that can be used to remotely connect to the device.", "Fetch support packet from a device remotely. Support packet is a zip archive that contains various system logs and debug data from a ChromeOS device. The support packet can be downloaded from the downloadURL link present in the `deviceFiles` field of [`chromeosdevices`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/chromeosdevices)" ], "type": "string" diff --git a/discovery/admin-reports_v1.json b/discovery/admin-reports_v1.json index 18bdcc3264..7ead0fb264 100644 --- a/discovery/admin-reports_v1.json +++ b/discovery/admin-reports_v1.json @@ -446,7 +446,7 @@ "type": "string" }, "parameters": { - "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", + "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `chat`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", "location": "query", "pattern": "(((accounts)|(app_maker)|(apps_scripts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)", "type": "string" @@ -570,7 +570,7 @@ "type": "string" }, "filters": { - "description": "The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). ", + "description": "The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `chat`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). ", "location": "query", "pattern": "(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)", "type": "string" @@ -603,7 +603,7 @@ "type": "string" }, "parameters": { - "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers Usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", + "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers Usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `chat`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", "location": "query", "pattern": "(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(chat)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)", "type": "string" @@ -626,7 +626,7 @@ } } }, - "revision": "20250424", + "revision": "20250505", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { diff --git a/discovery/adsense-v2.json b/discovery/adsense-v2.json index 076886dabf..ea8cee2121 100644 --- a/discovery/adsense-v2.json +++ b/discovery/adsense-v2.json @@ -2018,7 +2018,7 @@ } } }, - "revision": "20250320", + "revision": "20250506", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { @@ -2755,7 +2755,7 @@ "properties": { "mustFix": { "deprecated": true, - "description": "Required. Deprecated. Policy topics no longer have a \"must-fix\" classification.", + "description": "Required. Deprecated. Always set to false.", "type": "boolean" }, "topic": { diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 8609a2617d..ef43757206 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -15785,7 +15785,7 @@ ], "parameters": { "name": { - "description": "Identifier. The resource name of the ReasoningEngine.", + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, @@ -19841,7 +19841,7 @@ } } }, - "revision": "20250422", + "revision": "20250519", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -20483,6 +20483,10 @@ "apiKeySecretVersion": { "description": "Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}", "type": "string" + }, + "apiKeyString": { + "description": "The API key string. Either this or `api_key_secret_version` must be set.", + "type": "string" } }, "type": "object" @@ -20705,6 +20709,146 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1AuthConfig": { + "description": "Auth configuration to run the extension.", + "id": "GoogleCloudAiplatformV1AuthConfig", + "properties": { + "apiKeyConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigApiKeyConfig", + "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": [ + "", + "No Auth.", + "API Key Auth.", + "HTTP Basic Auth.", + "Google Service Account Auth.", + "OAuth auth.", + "OpenID Connect (OIDC) Auth." + ], + "type": "string" + }, + "googleServiceAccountConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig", + "description": "Config for Google Service Account auth." + }, + "httpBasicAuthConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig", + "description": "Config for HTTP Basic auth." + }, + "oauthConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigOauthConfig", + "description": "Config for user oauth." + }, + "oidcConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfigOidcConfig", + "description": "Config for user OIDC auth." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AuthConfigApiKeyConfig": { + "description": "Config for authentication with API key.", + "id": "GoogleCloudAiplatformV1AuthConfigApiKeyConfig", + "properties": { + "apiKeySecret": { + "description": "Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - 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" + }, + "apiKeyString": { + "description": "Optional. The API key to be used in the request directly.", + "type": "string" + }, + "httpElementLocation": { + "description": "Optional. 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": [ + "", + "Element is in the HTTP request query.", + "Element is in the HTTP request header.", + "Element is in the HTTP request path.", + "Element is in the HTTP request body.", + "Element is in the HTTP request cookie." + ], + "type": "string" + }, + "name": { + "description": "Optional. 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" + }, + "GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig": { + "description": "Config for Google Service Account Authentication.", + "id": "GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig", + "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" + }, + "GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig": { + "description": "Config for HTTP Basic Authentication.", + "id": "GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig", + "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" + }, + "GoogleCloudAiplatformV1AuthConfigOauthConfig": { + "description": "Config for user oauth.", + "id": "GoogleCloudAiplatformV1AuthConfigOauthConfig", + "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" + }, + "GoogleCloudAiplatformV1AuthConfigOidcConfig": { + "description": "Config for user OIDC auth.", + "id": "GoogleCloudAiplatformV1AuthConfigOidcConfig", + "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" + }, "GoogleCloudAiplatformV1AutomaticResources": { "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": "GoogleCloudAiplatformV1AutomaticResources", @@ -21580,6 +21724,10 @@ "description": "Optional. Immutable. The user-generated meaningful display name of the cached content.", "type": "string" }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key." + }, "expireTime": { "description": "Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.", "format": "google-datetime", @@ -21824,6 +21972,27 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1Checkpoint": { + "description": "Describes the machine learning model version checkpoint.", + "id": "GoogleCloudAiplatformV1Checkpoint", + "properties": { + "checkpointId": { + "description": "The ID of the checkpoint.", + "type": "string" + }, + "epoch": { + "description": "The epoch of the checkpoint.", + "format": "int64", + "type": "string" + }, + "step": { + "description": "The step of the checkpoint.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Citation": { "description": "Source attributions for content.", "id": "GoogleCloudAiplatformV1Citation", @@ -23805,6 +23974,10 @@ "$ref": "GoogleCloudAiplatformV1AutomaticResources", "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration." }, + "checkpointId": { + "description": "The checkpoint id of the model.", + "type": "string" + }, "createTime": { "description": "Output only. Timestamp when the DeployedModel was created.", "format": "google-datetime", @@ -23888,6 +24061,10 @@ "description": "Points to a DeployedModel.", "id": "GoogleCloudAiplatformV1DeployedModelRef", "properties": { + "checkpointId": { + "description": "Immutable. The ID of the Checkpoint deployed in the DeployedModel.", + "type": "string" + }, "deployedModelId": { "description": "Immutable. An ID of a DeployedModel in the above Endpoint.", "type": "string" @@ -25834,6 +26011,74 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ExternalApi": { + "description": "Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec.", + "id": "GoogleCloudAiplatformV1ExternalApi", + "properties": { + "apiAuth": { + "$ref": "GoogleCloudAiplatformV1ApiAuth", + "deprecated": true, + "description": "The authentication config to access the API. Deprecated. Please use auth_config instead." + }, + "apiSpec": { + "description": "The API spec that the external API implements.", + "enum": [ + "API_SPEC_UNSPECIFIED", + "SIMPLE_SEARCH", + "ELASTIC_SEARCH" + ], + "enumDescriptions": [ + "Unspecified API spec. This value should not be used.", + "Simple search API spec.", + "Elastic search API spec." + ], + "type": "string" + }, + "authConfig": { + "$ref": "GoogleCloudAiplatformV1AuthConfig", + "description": "The authentication config to access the API." + }, + "elasticSearchParams": { + "$ref": "GoogleCloudAiplatformV1ExternalApiElasticSearchParams", + "description": "Parameters for the elastic search API." + }, + "endpoint": { + "description": "The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search", + "type": "string" + }, + "simpleSearchParams": { + "$ref": "GoogleCloudAiplatformV1ExternalApiSimpleSearchParams", + "description": "Parameters for the simple search API." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExternalApiElasticSearchParams": { + "description": "The search parameters to use for the ELASTIC_SEARCH spec.", + "id": "GoogleCloudAiplatformV1ExternalApiElasticSearchParams", + "properties": { + "index": { + "description": "The ElasticSearch index to use.", + "type": "string" + }, + "numHits": { + "description": "Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.", + "format": "int32", + "type": "integer" + }, + "searchTemplate": { + "description": "The ElasticSearch search template to use.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ExternalApiSimpleSearchParams": { + "description": "The search parameters to use for SIMPLE_SEARCH spec.", + "id": "GoogleCloudAiplatformV1ExternalApiSimpleSearchParams", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1Fact": { "description": "The fact used in grounding.", "id": "GoogleCloudAiplatformV1Fact", @@ -27973,6 +28218,10 @@ "description": "Config for thinking features.", "id": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig", "properties": { + "includeThoughts": { + "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", + "type": "boolean" + }, "thinkingBudget": { "description": "Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.", "format": "int32", @@ -28655,6 +28904,10 @@ "$ref": "GoogleCloudAiplatformV1RagFileTransformationConfig", "description": "Specifies the transformation config for RagFiles." }, + "rebuildAnnIndex": { + "description": "Rebuilds the ANN index to optimize for recall on the imported data. Only applicable for RagCorpora running on RagManagedDb with `retrieval_strategy` set to `ANN`. The rebuild will be performed using the existing ANN config set on the RagCorpus. To change the ANN config, please use the UpdateRagCorpus API. Default is false, i.e., index is not rebuilt.", + "type": "boolean" + }, "sharePointSources": { "$ref": "GoogleCloudAiplatformV1SharePointSources", "description": "SharePoint sources." @@ -30276,6 +30529,7 @@ "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB", + "NVIDIA_B200", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -30297,6 +30551,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -30312,6 +30567,7 @@ "Nvidia H100 80Gb GPU.", "Nvidia H100 Mega 80Gb GPU.", "Nvidia H200 141Gb GPU.", + "Nvidia B200 GPU.", "TPU v2.", "TPU v3.", "TPU v4.", @@ -30942,6 +31198,14 @@ "$ref": "GoogleCloudAiplatformV1ModelBaseModelSource", "description": "Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models." }, + "checkpoints": { + "description": "Optional. Output only. The checkpoints of the model.", + "items": { + "$ref": "GoogleCloudAiplatformV1Checkpoint" + }, + "readOnly": true, + "type": "array" + }, "containerSpec": { "$ref": "GoogleCloudAiplatformV1ModelContainerSpec", "description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." @@ -32747,7 +33011,8 @@ "INVALID_TOKEN_VALUE", "INVALID_SPARSE_EMBEDDING", "INVALID_EMBEDDING", - "INVALID_EMBEDDING_METADATA" + "INVALID_EMBEDDING_METADATA", + "EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT" ], "enumDescriptions": [ "Default, shall not be used.", @@ -32768,7 +33033,8 @@ "Token restrict value is invalid.", "Invalid sparse embedding.", "Invalid dense embedding.", - "Invalid embedding metadata." + "Invalid embedding metadata.", + "Embedding metadata exceeds size limit." ], "type": "string" }, @@ -33133,7 +33399,7 @@ "type": "object" }, "GoogleCloudAiplatformV1NotebookRuntime": { - "description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.", + "description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.", "id": "GoogleCloudAiplatformV1NotebookRuntime", "properties": { "createTime": { @@ -33270,7 +33536,7 @@ "enumDescriptions": [ "Unspecified runtime state.", "NotebookRuntime is in running state.", - "NotebookRuntime is in starting state.", + "NotebookRuntime is in starting state. This is when the runtime is being started from a stopped state.", "NotebookRuntime is in stopping state.", "NotebookRuntime is in stopped state.", "NotebookRuntime is in upgrading state. It is in the middle of upgrading process.", @@ -33445,7 +33711,7 @@ "type": "object" }, "GoogleCloudAiplatformV1NotebookSoftwareConfig": { - "description": "Notebook Software Config.", + "description": "Notebook Software Config. This is passed to the backend when user makes software configurations in UI.", "id": "GoogleCloudAiplatformV1NotebookSoftwareConfig", "properties": { "env": { @@ -33797,6 +34063,11 @@ "description": "Optional. Text part (can be code).", "type": "string" }, + "thought": { + "description": "Output only. Indicates if the part is thought from the model.", + "readOnly": true, + "type": "boolean" + }, "videoMetadata": { "$ref": "GoogleCloudAiplatformV1VideoMetadata", "description": "Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data." @@ -36068,6 +36339,10 @@ "layoutParser": { "$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser", "description": "The Layout Parser to use for RagFiles." + }, + "llmParser": { + "$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser", + "description": "The LLM Parser to use for RagFiles." } }, "type": "object" @@ -36088,6 +36363,26 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser": { + "description": "Specifies the LLM parsing for RagFiles.", + "id": "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser", + "properties": { + "customParsingPrompt": { + "description": "The prompt to use for parsing. If not specified, a default prompt will be used.", + "type": "string" + }, + "maxParsingRequestsPerMin": { + "description": "The maximum number of requests the job is allowed to make to the LLM model per minute. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If unspecified, a default value of 5000 QPM would be used.", + "format": "int32", + "type": "integer" + }, + "modelName": { + "description": "The name of a LLM model used for parsing. Format: * `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RagFileTransformationConfig": { "description": "Specifies the transformation config for RagFiles.", "id": "GoogleCloudAiplatformV1RagFileTransformationConfig", @@ -36233,6 +36528,38 @@ "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb": { "description": "The config for the default RAG-managed Vector DB.", "id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb", + "properties": { + "ann": { + "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN", + "description": "Performs an ANN search on RagCorpus. Use this if you have a lot of files (> 10K) in your RagCorpus and want to reduce the search latency." + }, + "knn": { + "$ref": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN", + "description": "Performs a KNN search on RagCorpus. Default choice if not specified." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN": { + "description": "Config for ANN search. RagManagedDb uses a tree-based structure to partition data and facilitate faster searches. As a tradeoff, it requires longer indexing time and manual triggering of index rebuild via the ImportRagFiles and UpdateRagCorpus API.", + "id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN", + "properties": { + "leafCount": { + "description": "Number of leaf nodes in the tree-based structure. Each leaf node contains groups of closely related vectors along with their corresponding centroid. Recommended value is 10 * sqrt(num of RagFiles in your RagCorpus). Default value is 500.", + "format": "int32", + "type": "integer" + }, + "treeDepth": { + "description": "The depth of the tree-based structure. Only depth values of 2 and 3 are supported. Recommended value is 2 if you have if you have O(10K) files in the RagCorpus and set this to 3 if more than that. Default value is 2.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN": { + "description": "Config for KNN search.", + "id": "GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN", "properties": {}, "type": "object" }, @@ -36557,7 +36884,7 @@ "type": "string" }, "name": { - "description": "Identifier. The resource name of the ReasoningEngine.", + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" }, "spec": { @@ -36896,6 +37223,10 @@ "description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, + "externalApi": { + "$ref": "GoogleCloudAiplatformV1ExternalApi", + "description": "Use data source powered by external API for grounding." + }, "vertexAiSearch": { "$ref": "GoogleCloudAiplatformV1VertexAISearch", "description": "Set to use data source powered by Vertex AI Search." @@ -37689,6 +38020,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-object). More fields may be added in the future as needed.", "id": "GoogleCloudAiplatformV1Schema", "properties": { + "additionalProperties": { + "description": "Optional. Can either be a boolean or an object; controls the presence of additional properties.", + "type": "any" + }, "anyOf": { "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", "items": { @@ -37700,6 +38035,13 @@ "description": "Optional. Default value of the data.", "type": "any" }, + "defs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1Schema" + }, + "description": "Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.", + "type": "object" + }, "description": { "description": "Optional. The description of the data.", "type": "string" @@ -37785,6 +38127,10 @@ }, "type": "array" }, + "ref": { + "description": "Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring", + "type": "string" + }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "items": { @@ -43471,7 +43817,7 @@ "id": "GoogleCloudAiplatformV1SupervisedTuningDataStats", "properties": { "droppedExampleReasons": { - "description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.", + "description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.", "items": { "type": "string" }, @@ -43642,6 +43988,10 @@ "description": "Tuning Spec for Supervised Tuning for first party models.", "id": "GoogleCloudAiplatformV1SupervisedTuningSpec", "properties": { + "exportLastCheckpointOnly": { + "description": "Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.", + "type": "boolean" + }, "hyperParameters": { "$ref": "GoogleCloudAiplatformV1SupervisedHyperParameters", "description": "Optional. Hyperparameters for SFT." @@ -45274,6 +45624,14 @@ "description": "The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.", "id": "GoogleCloudAiplatformV1TunedModel", "properties": { + "checkpoints": { + "description": "Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.", + "items": { + "$ref": "GoogleCloudAiplatformV1TunedModelCheckpoint" + }, + "readOnly": true, + "type": "array" + }, "endpoint": { "description": "Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", "readOnly": true, @@ -45287,6 +45645,31 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1TunedModelCheckpoint": { + "description": "TunedModelCheckpoint for the Tuned Model of a Tuning Job.", + "id": "GoogleCloudAiplatformV1TunedModelCheckpoint", + "properties": { + "checkpointId": { + "description": "The ID of the checkpoint.", + "type": "string" + }, + "endpoint": { + "description": "The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", + "type": "string" + }, + "epoch": { + "description": "The epoch of the checkpoint.", + "format": "int64", + "type": "string" + }, + "step": { + "description": "The step of the checkpoint.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1TunedModelRef": { "description": "TunedModel Reference for legacy model migration.", "id": "GoogleCloudAiplatformV1TunedModelRef", @@ -45874,6 +46257,13 @@ "description": "Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder", "id": "GoogleCloudAiplatformV1VertexAISearch", "properties": { + "dataStoreSpecs": { + "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.", + "items": { + "$ref": "GoogleCloudAiplatformV1VertexAISearchDataStoreSpec" + }, + "type": "array" + }, "datastore": { "description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" @@ -45881,6 +46271,30 @@ "engine": { "description": "Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" + }, + "filter": { + "description": "Optional. Filter strings to be passed to the search API.", + "type": "string" + }, + "maxResults": { + "description": "Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1VertexAISearchDataStoreSpec": { + "description": "Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec", + "id": "GoogleCloudAiplatformV1VertexAISearchDataStoreSpec", + "properties": { + "dataStore": { + "description": "Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" } }, "type": "object" diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 4c36c4a172..eb319ff158 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -18845,7 +18845,7 @@ ], "parameters": { "name": { - "description": "Identifier. The resource name of the ReasoningEngine.", + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, @@ -19078,6 +19078,161 @@ } } }, + "sandboxEnvironments": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "sessions": { "methods": { "appendEvent": { @@ -23270,7 +23425,7 @@ } } }, - "revision": "20250422", + "revision": "20250519", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -23923,6 +24078,10 @@ "apiKeySecretVersion": { "description": "Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}", "type": "string" + }, + "apiKeyString": { + "description": "The API key string. Either this or `api_key_secret_version` must be set.", + "type": "string" } }, "type": "object" @@ -25346,6 +25505,10 @@ "description": "Optional. Immutable. The user-generated meaningful display name of the cached content.", "type": "string" }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", + "description": "Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key." + }, "expireTime": { "description": "Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.", "format": "google-datetime", @@ -25601,6 +25764,27 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Checkpoint": { + "description": "Describes the machine learning model version checkpoint.", + "id": "GoogleCloudAiplatformV1beta1Checkpoint", + "properties": { + "checkpointId": { + "description": "The ID of the checkpoint.", + "type": "string" + }, + "epoch": { + "description": "The epoch of the checkpoint.", + "format": "int64", + "type": "string" + }, + "step": { + "description": "The step of the checkpoint.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Citation": { "description": "Source attributions for content.", "id": "GoogleCloudAiplatformV1beta1Citation", @@ -27940,6 +28124,10 @@ "$ref": "GoogleCloudAiplatformV1beta1AutomaticResources", "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration." }, + "checkpointId": { + "description": "The checkpoint id of the model.", + "type": "string" + }, "createTime": { "description": "Output only. Timestamp when the DeployedModel was created.", "format": "google-datetime", @@ -28027,6 +28215,10 @@ "description": "Points to a DeployedModel.", "id": "GoogleCloudAiplatformV1beta1DeployedModelRef", "properties": { + "checkpointId": { + "description": "Immutable. The ID of the Checkpoint deployed in the DeployedModel.", + "type": "string" + }, "deployedModelId": { "description": "Immutable. An ID of a DeployedModel in the above Endpoint.", "type": "string" @@ -29192,7 +29384,6 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Example": { - "description": "A single example to upload or read from the Example Store.", "id": "GoogleCloudAiplatformV1beta1Example", "properties": { "createTime": { @@ -30436,6 +30627,74 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ExternalApi": { + "description": "Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec.", + "id": "GoogleCloudAiplatformV1beta1ExternalApi", + "properties": { + "apiAuth": { + "$ref": "GoogleCloudAiplatformV1beta1ApiAuth", + "deprecated": true, + "description": "The authentication config to access the API. Deprecated. Please use auth_config instead." + }, + "apiSpec": { + "description": "The API spec that the external API implements.", + "enum": [ + "API_SPEC_UNSPECIFIED", + "SIMPLE_SEARCH", + "ELASTIC_SEARCH" + ], + "enumDescriptions": [ + "Unspecified API spec. This value should not be used.", + "Simple search API spec.", + "Elastic search API spec." + ], + "type": "string" + }, + "authConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AuthConfig", + "description": "The authentication config to access the API." + }, + "elasticSearchParams": { + "$ref": "GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams", + "description": "Parameters for the elastic search API." + }, + "endpoint": { + "description": "The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search", + "type": "string" + }, + "simpleSearchParams": { + "$ref": "GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams", + "description": "Parameters for the simple search API." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams": { + "description": "The search parameters to use for the ELASTIC_SEARCH spec.", + "id": "GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams", + "properties": { + "index": { + "description": "The ElasticSearch index to use.", + "type": "string" + }, + "numHits": { + "description": "Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.", + "format": "int32", + "type": "integer" + }, + "searchTemplate": { + "description": "The ElasticSearch search template to use.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams": { + "description": "The search parameters to use for SIMPLE_SEARCH spec.", + "id": "GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Fact": { "description": "The fact used in grounding.", "id": "GoogleCloudAiplatformV1beta1Fact", @@ -31058,7 +31317,7 @@ "id": "GoogleCloudAiplatformV1beta1FeatureSelectionConfigFeatureConfig", "properties": { "driftThreshold": { - "description": "Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3.", + "description": "Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. Must be in range [0, 1).", "format": "double", "type": "number" }, @@ -33222,6 +33481,10 @@ "description": "Config for thinking features.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", "properties": { + "includeThoughts": { + "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", + "type": "boolean" + }, "thinkingBudget": { "description": "Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.", "format": "int32", @@ -33932,6 +34195,10 @@ "$ref": "GoogleCloudAiplatformV1beta1RagFileTransformationConfig", "description": "Specifies the transformation config for RagFiles." }, + "rebuildAnnIndex": { + "description": "Rebuilds the ANN index to optimize for recall on the imported data. Only applicable for RagCorpora running on RagManagedDb with `retrieval_strategy` set to `ANN`. The rebuild will be performed using the existing ANN config set on the RagCorpus. To change the ANN config, please use the UpdateRagCorpus API. Default is false, i.e., index is not rebuilt.", + "type": "boolean" + }, "sharePointSources": { "$ref": "GoogleCloudAiplatformV1beta1SharePointSources", "description": "SharePoint sources." @@ -35768,6 +36035,7 @@ "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB", + "NVIDIA_B200", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -35789,6 +36057,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -35804,6 +36073,7 @@ "Nvidia H100 80Gb GPU.", "Nvidia H100 Mega 80Gb GPU.", "Nvidia H200 141Gb GPU.", + "Nvidia B200 GPU.", "TPU v2.", "TPU v3.", "TPU v4.", @@ -36439,6 +36709,14 @@ "$ref": "GoogleCloudAiplatformV1beta1ModelBaseModelSource", "description": "Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models." }, + "checkpoints": { + "description": "Optional. Output only. The checkpoints of the model.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Checkpoint" + }, + "readOnly": true, + "type": "array" + }, "containerSpec": { "$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec", "description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." @@ -37261,6 +37539,10 @@ "description": "The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8.", "type": "string" }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", + "description": "Customer-managed encryption key spec for a ModelMonitor. If set, this ModelMonitor and all sub-resources of this ModelMonitor will be secured by this key." + }, "explanationSpec": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpec", "description": "Optional model explanation spec. It is used for feature attribution monitoring." @@ -39011,7 +39293,8 @@ "INVALID_TOKEN_VALUE", "INVALID_SPARSE_EMBEDDING", "INVALID_EMBEDDING", - "INVALID_EMBEDDING_METADATA" + "INVALID_EMBEDDING_METADATA", + "EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT" ], "enumDescriptions": [ "Default, shall not be used.", @@ -39032,7 +39315,8 @@ "Token restrict value is invalid.", "Invalid sparse embedding.", "Invalid dense embedding.", - "Invalid embedding metadata." + "Invalid embedding metadata.", + "Embedding metadata exceeds size limit." ], "type": "string" }, @@ -39397,7 +39681,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1NotebookRuntime": { - "description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.", + "description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.", "id": "GoogleCloudAiplatformV1beta1NotebookRuntime", "properties": { "createTime": { @@ -39534,7 +39818,7 @@ "enumDescriptions": [ "Unspecified runtime state.", "NotebookRuntime is in running state.", - "NotebookRuntime is in starting state.", + "NotebookRuntime is in starting state. This is when the runtime is being started from a stopped state.", "NotebookRuntime is in stopping state.", "NotebookRuntime is in stopped state.", "NotebookRuntime is in upgrading state. It is in the middle of upgrading process.", @@ -39709,7 +39993,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig": { - "description": "Notebook Software Config.", + "description": "Notebook Software Config. This is passed to the backend when user makes software configurations in UI.", "id": "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig", "properties": { "env": { @@ -42479,6 +42763,10 @@ "description": "Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", + "description": "Optional. Immutable. The CMEK key name used to encrypt at-rest data related to this Corpus. Only applicable to RagManagedDb option for Vector DB. This field can only be set at corpus creation time, and cannot be updated or deleted." + }, "name": { "description": "Output only. The resource name of the RagCorpus.", "readOnly": true, @@ -42797,7 +43085,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1RagFileParsingConfigLlmParser": { - "description": "Specifies the advanced parsing for RagFiles.", + "description": "Specifies the LLM parsing for RagFiles.", "id": "GoogleCloudAiplatformV1beta1RagFileParsingConfigLlmParser", "properties": { "customParsingPrompt": { @@ -43040,6 +43328,38 @@ "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb": { "description": "The config for the default RAG-managed Vector DB.", "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb", + "properties": { + "ann": { + "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN", + "description": "Performs an ANN search on RagCorpus. Use this if you have a lot of files (> 10K) in your RagCorpus and want to reduce the search latency." + }, + "knn": { + "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN", + "description": "Performs a KNN search on RagCorpus. Default choice if not specified." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN": { + "description": "Config for ANN search. RagManagedDb uses a tree-based structure to partition data and facilitate faster searches. As a tradeoff, it requires longer indexing time and manual triggering of index rebuild via the ImportRagFiles and UpdateRagCorpus API.", + "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN", + "properties": { + "leafCount": { + "description": "Number of leaf nodes in the tree-based structure. Each leaf node contains groups of closely related vectors along with their corresponding centroid. Recommended value is 10 * sqrt(num of RagFiles in your RagCorpus). Default value is 500.", + "format": "int32", + "type": "integer" + }, + "treeDepth": { + "description": "The depth of the tree-based structure. Only depth values of 2 and 3 are supported. Recommended value is 2 if you have if you have O(10K) files in the RagCorpus and set this to 3 if more than that. Default value is 2.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN": { + "description": "Config for KNN search.", + "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN", "properties": {}, "type": "object" }, @@ -43397,7 +43717,7 @@ "type": "string" }, "name": { - "description": "Identifier. The resource name of the ReasoningEngine.", + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" }, "spec": { @@ -43869,6 +44189,10 @@ "description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, + "externalApi": { + "$ref": "GoogleCloudAiplatformV1beta1ExternalApi", + "description": "Use data source powered by external API for grounding." + }, "vertexAiSearch": { "$ref": "GoogleCloudAiplatformV1beta1VertexAISearch", "description": "Set to use data source powered by Vertex AI Search." @@ -44816,6 +45140,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-object). More fields may be added in the future as needed.", "id": "GoogleCloudAiplatformV1beta1Schema", "properties": { + "additionalProperties": { + "description": "Optional. Can either be a boolean or an object; controls the presence of additional properties.", + "type": "any" + }, "anyOf": { "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", "items": { @@ -44827,6 +45155,13 @@ "description": "Optional. Default value of the data.", "type": "any" }, + "defs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1Schema" + }, + "description": "Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.", + "type": "object" + }, "description": { "description": "Optional. The description of the data.", "type": "string" @@ -44912,6 +45247,10 @@ }, "type": "array" }, + "ref": { + "description": "Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring", + "type": "string" + }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "items": { @@ -51073,7 +51412,7 @@ "id": "GoogleCloudAiplatformV1beta1SupervisedTuningDataStats", "properties": { "droppedExampleReasons": { - "description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.", + "description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.", "items": { "type": "string" }, @@ -51244,6 +51583,10 @@ "description": "Tuning Spec for Supervised Tuning for first party models.", "id": "GoogleCloudAiplatformV1beta1SupervisedTuningSpec", "properties": { + "exportLastCheckpointOnly": { + "description": "Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.", + "type": "boolean" + }, "hyperParameters": { "$ref": "GoogleCloudAiplatformV1beta1SupervisedHyperParameters", "description": "Optional. Hyperparameters for SFT." @@ -52934,6 +53277,14 @@ "description": "The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.", "id": "GoogleCloudAiplatformV1beta1TunedModel", "properties": { + "checkpoints": { + "description": "Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1TunedModelCheckpoint" + }, + "readOnly": true, + "type": "array" + }, "endpoint": { "description": "Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", "readOnly": true, @@ -52947,6 +53298,31 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1TunedModelCheckpoint": { + "description": "TunedModelCheckpoint for the Tuned Model of a Tuning Job.", + "id": "GoogleCloudAiplatformV1beta1TunedModelCheckpoint", + "properties": { + "checkpointId": { + "description": "The ID of the checkpoint.", + "type": "string" + }, + "endpoint": { + "description": "The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", + "type": "string" + }, + "epoch": { + "description": "The epoch of the checkpoint.", + "format": "int64", + "type": "string" + }, + "step": { + "description": "The step of the checkpoint.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1TunedModelRef": { "description": "TunedModel Reference for legacy model migration.", "id": "GoogleCloudAiplatformV1beta1TunedModelRef", @@ -53627,6 +54003,13 @@ "description": "Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder", "id": "GoogleCloudAiplatformV1beta1VertexAISearch", "properties": { + "dataStoreSpecs": { + "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec" + }, + "type": "array" + }, "datastore": { "description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" @@ -53634,6 +54017,30 @@ "engine": { "description": "Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" + }, + "filter": { + "description": "Optional. Filter strings to be passed to the search API.", + "type": "string" + }, + "maxResults": { + "description": "Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec": { + "description": "Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec", + "id": "GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec", + "properties": { + "dataStore": { + "description": "Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" } }, "type": "object" diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index 42d83df666..c26046ce71 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -1622,7 +1622,7 @@ } } }, - "revision": "20250410", + "revision": "20250508", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2324,7 +2324,7 @@ "id": "ContinuousBackupInfo", "properties": { "earliestRestorableTime": { - "description": "Output only. The earliest restorable time that can be restored to. Output only field.", + "description": "Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes \"now minus the recovery window\". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2341,7 +2341,7 @@ "readOnly": true }, "schedule": { - "description": "Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.", + "description": "Output only. Days of the week on which a continuous backup is taken.", "items": { "enum": [ "DAY_OF_WEEK_UNSPECIFIED", @@ -2737,6 +2737,20 @@ "description": "An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.", "id": "Instance", "properties": { + "activationPolicy": { + "description": "Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.", + "enum": [ + "ACTIVATION_POLICY_UNSPECIFIED", + "ALWAYS", + "NEVER" + ], + "enumDescriptions": [ + "The policy is not specified.", + "The instance is running.", + "The instance is not running." + ], + "type": "string" + }, "annotations": { "additionalProperties": { "type": "string" @@ -2931,6 +2945,10 @@ "description": "Metadata related to instance-level network configuration.", "id": "InstanceNetworkConfig", "properties": { + "allocatedIpRangeOverride": { + "description": "Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: \"google-managed-services-default\". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.", + "type": "string" + }, "authorizedExternalNetworks": { "description": "Optional. A list of external network authorized to access this instance.", "items": { @@ -4352,7 +4370,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -4444,6 +4468,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4536,7 +4566,13 @@ "Deletion Protection Disabled for the resource", "Indicates that the instance has inefficient queries detected.", "Indicates that the instance has read intensive workload.", - "Indicates that the instance is nearing memory limit." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" }, @@ -4947,7 +4983,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -5039,6 +5081,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -5131,7 +5179,13 @@ "Deletion Protection Disabled for the resource", "Indicates that the instance has inefficient queries detected.", "Indicates that the instance has read intensive workload.", - "Indicates that the instance is nearing memory limit." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" } @@ -5493,8 +5547,9 @@ "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", - "PRODUCT_TYPE_OTHER", - "PRODUCT_TYPE_FIRESTORE" + "PRODUCT_TYPE_FIRESTORE", + "PRODUCT_TYPE_COMPUTE_ENGINE", + "PRODUCT_TYPE_OTHER" ], "enumDeprecated": [ false, @@ -5508,6 +5563,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5521,8 +5577,9 @@ "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", - "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", - "Firestore product area in GCP." + "Firestore product area in GCP.", + "Compute Engine self managed databases", + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "type": "string" }, diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index 0cd1bec658..88ab4e853d 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -1622,7 +1622,7 @@ } } }, - "revision": "20250410", + "revision": "20250508", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2427,7 +2427,7 @@ "id": "ContinuousBackupInfo", "properties": { "earliestRestorableTime": { - "description": "Output only. The earliest restorable time that can be restored to. Output only field.", + "description": "Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes \"now minus the recovery window\". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2444,7 +2444,7 @@ "readOnly": true }, "schedule": { - "description": "Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.", + "description": "Output only. Days of the week on which a continuous backup is taken.", "items": { "enum": [ "DAY_OF_WEEK_UNSPECIFIED", @@ -2863,6 +2863,20 @@ "description": "An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.", "id": "Instance", "properties": { + "activationPolicy": { + "description": "Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.", + "enum": [ + "ACTIVATION_POLICY_UNSPECIFIED", + "ALWAYS", + "NEVER" + ], + "enumDescriptions": [ + "The policy is not specified.", + "The instance is running.", + "The instance is not running." + ], + "type": "string" + }, "annotations": { "additionalProperties": { "type": "string" @@ -3080,6 +3094,10 @@ "description": "Metadata related to instance-level network configuration.", "id": "InstanceNetworkConfig", "properties": { + "allocatedIpRangeOverride": { + "description": "Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: \"google-managed-services-default\". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.", + "type": "string" + }, "authorizedExternalNetworks": { "description": "Optional. A list of external network authorized to access this instance.", "items": { @@ -4505,7 +4523,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -4597,6 +4621,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4689,7 +4719,13 @@ "Deletion Protection Disabled for the resource", "Indicates that the instance has inefficient queries detected.", "Indicates that the instance has read intensive workload.", - "Indicates that the instance is nearing memory limit." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" }, @@ -5100,7 +5136,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -5192,6 +5234,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -5284,7 +5332,13 @@ "Deletion Protection Disabled for the resource", "Indicates that the instance has inefficient queries detected.", "Indicates that the instance has read intensive workload.", - "Indicates that the instance is nearing memory limit." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" } @@ -5646,8 +5700,9 @@ "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", - "PRODUCT_TYPE_OTHER", - "PRODUCT_TYPE_FIRESTORE" + "PRODUCT_TYPE_FIRESTORE", + "PRODUCT_TYPE_COMPUTE_ENGINE", + "PRODUCT_TYPE_OTHER" ], "enumDeprecated": [ false, @@ -5661,6 +5716,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5674,8 +5730,9 @@ "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", - "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", - "Firestore product area in GCP." + "Firestore product area in GCP.", + "Compute Engine self managed databases", + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "type": "string" }, diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 63443e296f..edee68bd80 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -1619,7 +1619,7 @@ } } }, - "revision": "20250410", + "revision": "20250508", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2408,7 +2408,7 @@ "id": "ContinuousBackupInfo", "properties": { "earliestRestorableTime": { - "description": "Output only. The earliest restorable time that can be restored to. Output only field.", + "description": "Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes \"now minus the recovery window\". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -2425,7 +2425,7 @@ "readOnly": true }, "schedule": { - "description": "Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.", + "description": "Output only. Days of the week on which a continuous backup is taken.", "items": { "enum": [ "DAY_OF_WEEK_UNSPECIFIED", @@ -2844,6 +2844,20 @@ "description": "An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.", "id": "Instance", "properties": { + "activationPolicy": { + "description": "Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.", + "enum": [ + "ACTIVATION_POLICY_UNSPECIFIED", + "ALWAYS", + "NEVER" + ], + "enumDescriptions": [ + "The policy is not specified.", + "The instance is running.", + "The instance is not running." + ], + "type": "string" + }, "annotations": { "additionalProperties": { "type": "string" @@ -3056,6 +3070,10 @@ "description": "Metadata related to instance-level network configuration.", "id": "InstanceNetworkConfig", "properties": { + "allocatedIpRangeOverride": { + "description": "Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: \"google-managed-services-default\". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.", + "type": "string" + }, "authorizedExternalNetworks": { "description": "Optional. A list of external network authorized to access this instance.", "items": { @@ -4481,7 +4499,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -4573,6 +4597,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4665,7 +4695,13 @@ "Deletion Protection Disabled for the resource", "Indicates that the instance has inefficient queries detected.", "Indicates that the instance has read intensive workload.", - "Indicates that the instance is nearing memory limit." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" }, @@ -5076,7 +5112,13 @@ "SIGNAL_TYPE_NO_DELETION_PROTECTION", "SIGNAL_TYPE_INEFFICIENT_QUERY", "SIGNAL_TYPE_READ_INTENSIVE_WORKLOAD", - "SIGNAL_TYPE_MEMORY_LIMIT" + "SIGNAL_TYPE_MEMORY_LIMIT", + "SIGNAL_TYPE_MAX_SERVER_MEMORY", + "SIGNAL_TYPE_LARGE_ROWS", + "SIGNAL_TYPE_HIGH_WRITE_PRESSURE", + "SIGNAL_TYPE_HIGH_READ_PRESSURE", + "SIGNAL_TYPE_ENCRYPTION_ORG_POLICY_NOT_SATISFIED", + "SIGNAL_TYPE_LOCATION_ORG_POLICY_NOT_SATISFIED" ], "enumDeprecated": [ false, @@ -5168,6 +5210,12 @@ false, false, false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -5260,7 +5308,13 @@ "Deletion Protection Disabled for the resource", "Indicates that the instance has inefficient queries detected.", "Indicates that the instance has read intensive workload.", - "Indicates that the instance is nearing memory limit." + "Indicates that the instance is nearing memory limit.", + "Indicates that the instance's max server memory is configured higher than the recommended value.", + "Indicates that the database has large rows beyond the recommended limit.", + "Heavy write pressure on the database rows.", + "Heavy read pressure on the database rows.", + "Encryption org policy not satisfied.", + "Location org policy not satisfied." ], "type": "string" } @@ -5622,8 +5676,9 @@ "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", - "PRODUCT_TYPE_OTHER", - "PRODUCT_TYPE_FIRESTORE" + "PRODUCT_TYPE_FIRESTORE", + "PRODUCT_TYPE_COMPUTE_ENGINE", + "PRODUCT_TYPE_OTHER" ], "enumDeprecated": [ false, @@ -5637,6 +5692,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5650,8 +5706,9 @@ "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", - "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", - "Firestore product area in GCP." + "Firestore product area in GCP.", + "Compute Engine self managed databases", + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." ], "type": "string" }, diff --git a/discovery/analyticshub-v1.json b/discovery/analyticshub-v1.json index 210dba5bc4..ead515d93a 100644 --- a/discovery/analyticshub-v1.json +++ b/discovery/analyticshub-v1.json @@ -124,7 +124,7 @@ ], "parameters": { "organization": { - "description": "Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`.", + "description": "Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/us`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -178,7 +178,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`.", + "description": "Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/us`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -207,7 +207,7 @@ ], "parameters": { "name": { - "description": "Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -233,7 +233,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Required. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -299,7 +299,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`.", + "description": "Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/us`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -341,7 +341,7 @@ "type": "string" }, "resource": { - "description": "Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789", + "description": "Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/us/dataExchanges/456 OR e.g. projects/123/locations/us/dataExchanges/456/listings/789", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -367,7 +367,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -422,7 +422,7 @@ ] }, "subscribe": { - "description": "Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.", + "description": "Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:subscribe", "httpMethod": "POST", "id": "analyticshub.projects.locations.dataExchanges.subscribe", @@ -431,7 +431,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123`", + "description": "Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/us/dataExchanges/123`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -498,7 +498,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -532,7 +532,7 @@ "type": "boolean" }, "name": { - "description": "Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", + "description": "Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", "required": true, @@ -558,7 +558,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", + "description": "Required. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", "required": true, @@ -624,7 +624,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -666,7 +666,7 @@ "type": "string" }, "resource": { - "description": "Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789", + "description": "Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/us/dataExchanges/456 OR e.g. projects/123/locations/us/dataExchanges/456/listings/789", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", "required": true, @@ -692,7 +692,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`", + "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", "required": true, @@ -756,7 +756,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", + "description": "Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", "required": true, @@ -820,7 +820,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456", + "description": "Required. Resource name of the subscription to delete. e.g. projects/123/locations/us/subscriptions/456", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$", "required": true, @@ -846,7 +846,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456", + "description": "Required. Resource name of the subscription. e.g. projects/123/locations/us/subscriptions/456", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$", "required": true, @@ -917,7 +917,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US", + "description": "Required. The parent resource path of the subscription. e.g. projects/myproject/locations/us", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -943,7 +943,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123`", + "description": "Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/us/subscriptions/123`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$", "required": true, @@ -972,7 +972,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456", + "description": "Required. Resource name of the subscription to revoke. e.g. projects/123/locations/us/subscriptions/456", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$", "required": true, @@ -1027,7 +1027,7 @@ } } }, - "revision": "20250418", + "revision": "20250507", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1264,7 +1264,7 @@ "type": "boolean" }, "name": { - "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "readOnly": true, "type": "string" }, @@ -1359,13 +1359,6 @@ "location": { "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", "type": "string" - }, - "replicaLocations": { - "description": "Optional. The geographic locations where the dataset should be replicated. See https://cloud.google.com/bigquery/docs/locations for supported locations.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" @@ -1835,7 +1828,7 @@ "type": "boolean" }, "name": { - "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`", + "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`", "readOnly": true, "type": "string" }, @@ -2283,7 +2276,7 @@ "id": "SubscribeDataExchangeRequest", "properties": { "destination": { - "description": "Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/US`", + "description": "Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/us`", "type": "string" }, "destinationDataset": { @@ -2354,10 +2347,14 @@ "type": "string" }, "dataExchange": { - "description": "Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456", + "description": "Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456", "readOnly": true, "type": "string" }, + "destinationDataset": { + "$ref": "DestinationDataset", + "description": "Optional. BigQuery destination dataset to create for the subscriber." + }, "lastModifyTime": { "description": "Output only. Timestamp when the subscription was last modified.", "format": "google-datetime", @@ -2368,7 +2365,7 @@ "additionalProperties": { "$ref": "LinkedResource" }, - "description": "Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.", + "description": "Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.", "readOnly": true, "type": "object" }, @@ -2381,7 +2378,7 @@ "type": "array" }, "listing": { - "description": "Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789", + "description": "Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789", "readOnly": true, "type": "string" }, @@ -2391,7 +2388,7 @@ "type": "boolean" }, "name": { - "description": "Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.", + "description": "Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`.", "readOnly": true, "type": "string" }, diff --git a/discovery/analyticshub-v1beta1.json b/discovery/analyticshub-v1beta1.json index ad520e54f7..770977ace9 100644 --- a/discovery/analyticshub-v1beta1.json +++ b/discovery/analyticshub-v1beta1.json @@ -124,7 +124,7 @@ ], "parameters": { "organization": { - "description": "Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`.", + "description": "Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/us`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -178,7 +178,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`.", + "description": "Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/us`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -207,7 +207,7 @@ ], "parameters": { "name": { - "description": "Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -233,7 +233,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Required. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -299,7 +299,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`.", + "description": "Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/us`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -325,7 +325,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -427,7 +427,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -456,7 +456,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", + "description": "Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", "required": true, @@ -482,7 +482,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", + "description": "Required. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", "required": true, @@ -548,7 +548,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+$", "required": true, @@ -574,7 +574,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`", + "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", "required": true, @@ -638,7 +638,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.", + "description": "Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataExchanges/[^/]+/listings/[^/]+$", "required": true, @@ -695,7 +695,7 @@ } } }, - "revision": "20250418", + "revision": "20250507", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -819,7 +819,7 @@ "type": "integer" }, "name": { - "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.", + "description": "Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.", "readOnly": true, "type": "string" }, @@ -845,6 +845,50 @@ }, "type": "object" }, + "DestinationDataset": { + "description": "Defines the destination bigquery dataset.", + "id": "DestinationDataset", + "properties": { + "datasetReference": { + "$ref": "DestinationDatasetReference", + "description": "Required. A reference that identifies the destination dataset." + }, + "description": { + "description": "Optional. A user-friendly description of the dataset.", + "type": "string" + }, + "friendlyName": { + "description": "Optional. A descriptive name for the dataset.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.", + "type": "object" + }, + "location": { + "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", + "type": "string" + } + }, + "type": "object" + }, + "DestinationDatasetReference": { + "id": "DestinationDatasetReference", + "properties": { + "datasetId": { + "description": "Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.", + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the project containing this dataset.", + "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", @@ -1113,7 +1157,7 @@ "type": "string" }, "name": { - "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`", + "description": "Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`", "readOnly": true, "type": "string" }, @@ -1330,10 +1374,14 @@ "type": "string" }, "dataExchange": { - "description": "Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456", + "description": "Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456", "readOnly": true, "type": "string" }, + "destinationDataset": { + "$ref": "DestinationDataset", + "description": "Optional. BigQuery destination dataset to create for the subscriber." + }, "lastModifyTime": { "description": "Output only. Timestamp when the subscription was last modified.", "format": "google-datetime", @@ -1344,7 +1392,7 @@ "additionalProperties": { "$ref": "LinkedResource" }, - "description": "Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.", + "description": "Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.", "readOnly": true, "type": "object" }, @@ -1357,7 +1405,7 @@ "type": "array" }, "listing": { - "description": "Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789", + "description": "Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789", "readOnly": true, "type": "string" }, @@ -1367,7 +1415,7 @@ "type": "boolean" }, "name": { - "description": "Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.", + "description": "Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`.", "readOnly": true, "type": "string" }, diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index 565cd83eab..188ba315d8 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -343,7 +343,7 @@ "devices": { "methods": { "delete": { - "description": "Deletes a device. This operation wipes the device. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.", + "description": "Deletes a device. This operation attempts to wipe the device but this is not guaranteed to succeed if the device is offline for an extended period. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.", "flatPath": "v1/enterprises/{enterprisesId}/devices/{devicesId}", "httpMethod": "DELETE", "id": "androidmanagement.enterprises.devices.delete", @@ -1202,7 +1202,7 @@ } } }, - "revision": "20250501", + "revision": "20250515", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1354,6 +1354,274 @@ }, "type": "object" }, + "ApnPolicy": { + "description": "Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details.", + "id": "ApnPolicy", + "properties": { + "apnSettings": { + "description": "Optional. APN settings for override APNs. There must not be any conflict between any of APN settings provided, otherwise the policy will be rejected. Two ApnSettings are considered to conflict when all of the following fields match on both: numericOperatorId, apn, proxyAddress, proxyPort, mmsProxyAddress, mmsProxyPort, mmsc, mvnoType, protocol, roamingProtocol. If some of the APN settings result in non-compliance of INVALID_VALUE , they will be ignored. This can be set on fully managed devices on Android 10 and above. This can also be set on work profiles on Android 13 and above and only with ApnSetting's with ENTERPRISE APN type. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles on Android versions less than 13.", + "items": { + "$ref": "ApnSetting" + }, + "type": "array" + }, + "overrideApns": { + "description": "Optional. Whether override APNs are disabled or enabled. See DevicePolicyManager.setOverrideApnsEnabled (https://developer.android.com/reference/android/app/admin/DevicePolicyManager#setOverrideApnsEnabled) for more details.", + "enum": [ + "OVERRIDE_APNS_UNSPECIFIED", + "OVERRIDE_APNS_DISABLED", + "OVERRIDE_APNS_ENABLED" + ], + "enumDescriptions": [ + "Unspecified. Defaults to OVERRIDE_APNS_DISABLED.", + "Override APNs disabled. Any configured apnSettings are saved on the device, but are disabled and have no effect. Any other APNs on the device remain in use.", + "Override APNs enabled. Only override APNs are in use, any other APNs are ignored. This can only be set on fully managed devices on Android 10 and above. For work profiles override APNs are enabled via preferentialNetworkServiceSettings and this value cannot be set. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles." + ], + "type": "string" + } + }, + "type": "object" + }, + "ApnSetting": { + "description": "An Access Point Name (APN) configuration for a carrier data connection. The APN provides configuration to connect a cellular network device to an IP data network. A carrier uses this setting to decide which IP address to assign, any security methods to apply, and how the device might be connected to private networks.", + "id": "ApnSetting", + "properties": { + "alwaysOnSetting": { + "description": "Optional. Whether User Plane resources have to be activated during every transition from CM-IDLE mode to CM-CONNECTED state for this APN. See 3GPP TS 23.501 section 5.6.13.", + "enum": [ + "ALWAYS_ON_SETTING_UNSPECIFIED", + "NOT_ALWAYS_ON", + "ALWAYS_ON" + ], + "enumDescriptions": [ + "Unspecified. Defaults to NOT_ALWAYS_ON.", + "The PDU session brought up by this APN should not be always on.", + "The PDU session brought up by this APN should always be on. Supported on Android 15 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 15." + ], + "type": "string" + }, + "apn": { + "description": "Required. Name of the APN. Policy will be rejected if this field is empty.", + "type": "string" + }, + "apnTypes": { + "description": "Required. Usage categories for the APN. Policy will be rejected if this field is empty or contains APN_TYPE_UNSPECIFIED or duplicates. Multiple APN types can be set on fully managed devices. ENTERPRISE is the only allowed APN type on work profiles. A nonComplianceDetail with MANAGEMENT_MODE is reported for any other value on work profiles. APN types that are not supported on the device or management mode will be ignored. If this results in the empty list, the APN setting will be ignored, because apnTypes is a required field. A nonComplianceDetail with INVALID_VALUE is reported if none of the APN types are supported on the device or management mode.", + "items": { + "enum": [ + "APN_TYPE_UNSPECIFIED", + "ENTERPRISE", + "BIP", + "CBS", + "DEFAULT", + "DUN", + "EMERGENCY", + "FOTA", + "HIPRI", + "IA", + "IMS", + "MCX", + "MMS", + "RCS", + "SUPL", + "VSIM", + "XCAP" + ], + "enumDescriptions": [ + "Unspecified. This value is not used.", + "APN type for enterprise traffic. Supported on Android 13 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 13.", + "APN type for BIP (Bearer Independent Protocol). This can only be set on fully managed devices on Android 12 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 12. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for CBS (Carrier Branded Services). This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for default data traffic. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for DUN (Dial-up networking) traffic. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for Emergency PDN. This is not an IA apn, but is used for access to carrier services in an emergency call situation. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for accessing the carrier's FOTA (Firmware Over-the-Air) portal, used for over the air updates. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for HiPri (high-priority) traffic. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for IA (Initial Attach) APN. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for IMS (IP Multimedia Subsystem) traffic. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for MCX (Mission Critical Service) where X can be PTT/Video/Data. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for MMS (Multimedia Messaging Service) traffic. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for RCS (Rich Communication Services). This can only be set on fully managed devices on Android 15 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 15. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for SUPL (Secure User Plane Location) assisted GPS. This can only be set on fully managed devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for VSIM (Virtual SIM) service. This can only be set on fully managed devices on Android 12 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 12. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles.", + "APN type for XCAP (XML Configuration Access Protocol) traffic. This can only be set on fully managed devices on Android 11 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 11. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles." + ], + "type": "string" + }, + "type": "array" + }, + "authType": { + "description": "Optional. Authentication type of the APN.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "NONE", + "PAP", + "CHAP", + "PAP_OR_CHAP" + ], + "enumDescriptions": [ + "Unspecified. If username is empty, defaults to NONE. Otherwise, defaults to PAP_OR_CHAP.", + "Authentication is not required.", + "Authentication type for PAP.", + "Authentication type for CHAP.", + "Authentication type for PAP or CHAP." + ], + "type": "string" + }, + "carrierId": { + "description": "Optional. Carrier ID for the APN. A value of 0 (default) means not set and negative values are rejected.", + "format": "int32", + "type": "integer" + }, + "displayName": { + "description": "Required. Human-readable name that describes the APN. Policy will be rejected if this field is empty.", + "type": "string" + }, + "mmsProxyAddress": { + "description": "Optional. MMS (Multimedia Messaging Service) proxy address of the APN which can be an IP address or hostname (not a URL).", + "type": "string" + }, + "mmsProxyPort": { + "description": "Optional. MMS (Multimedia Messaging Service) proxy port of the APN. A value of 0 (default) means not set and negative values are rejected.", + "format": "int32", + "type": "integer" + }, + "mmsc": { + "description": "Optional. MMSC (Multimedia Messaging Service Center) URI of the APN.", + "type": "string" + }, + "mtuV4": { + "description": "Optional. The default MTU (Maximum Transmission Unit) size in bytes of the IPv4 routes brought up by this APN setting. A value of 0 (default) means not set and negative values are rejected. Supported on Android 13 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 13.", + "format": "int32", + "type": "integer" + }, + "mtuV6": { + "description": "Optional. The MTU (Maximum Transmission Unit) size of the IPv6 mobile interface to which the APN connected. A value of 0 (default) means not set and negative values are rejected. Supported on Android 13 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 13.", + "format": "int32", + "type": "integer" + }, + "mvnoType": { + "description": "Optional. MVNO match type for the APN.", + "enum": [ + "MVNO_TYPE_UNSPECIFIED", + "GID", + "ICCID", + "IMSI", + "SPN" + ], + "enumDescriptions": [ + "The MVNO type is not specified.", + "MVNO type for group identifier level 1.", + "MVNO type for ICCID.", + "MVNO type for IMSI.", + "MVNO type for SPN (service provider name)." + ], + "type": "string" + }, + "networkTypes": { + "description": "Optional. Radio technologies (network types) the APN may use. Policy will be rejected if this field contains NETWORK_TYPE_UNSPECIFIED or duplicates.", + "items": { + "enum": [ + "NETWORK_TYPE_UNSPECIFIED", + "EDGE", + "GPRS", + "GSM", + "HSDPA", + "HSPA", + "HSPAP", + "HSUPA", + "IWLAN", + "LTE", + "NR", + "TD_SCDMA", + "UMTS" + ], + "enumDescriptions": [ + "Unspecified. This value must not be used.", + "Radio technology EDGE.", + "Radio technology GPRS.", + "Radio technology GSM.", + "Radio technology HSDPA.", + "Radio technology HSPA.", + "Radio technology HSPAP.", + "Radio technology HSUPA.", + "Radio technology IWLAN.", + "Radio technology LTE.", + "Radio technology NR (New Radio) 5G.", + "Radio technology TD_SCDMA.", + "Radio technology UMTS." + ], + "type": "string" + }, + "type": "array" + }, + "numericOperatorId": { + "description": "Optional. The numeric operator ID of the APN. Numeric operator ID is defined as MCC (Mobile Country Code) + MNC (Mobile Network Code).", + "type": "string" + }, + "password": { + "description": "Optional. APN password of the APN.", + "type": "string" + }, + "protocol": { + "description": "Optional. The protocol to use to connect to this APN.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "IP", + "IPV4V6", + "IPV6", + "NON_IP", + "PPP", + "UNSTRUCTURED" + ], + "enumDescriptions": [ + "The protocol is not specified.", + "Internet protocol.", + "Virtual PDP type introduced to handle dual IP stack UE capability.", + "Internet protocol, version 6.", + "Transfer of Non-IP data to external packet data network.", + "Point to point protocol.", + "Transfer of Unstructured data to the Data Network via N6." + ], + "type": "string" + }, + "proxyAddress": { + "description": "Optional. The proxy address of the APN.", + "type": "string" + }, + "proxyPort": { + "description": "Optional. The proxy port of the APN. A value of 0 (default) means not set and negative values are rejected.", + "format": "int32", + "type": "integer" + }, + "roamingProtocol": { + "description": "Optional. The protocol to use to connect to this APN while the device is roaming.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "IP", + "IPV4V6", + "IPV6", + "NON_IP", + "PPP", + "UNSTRUCTURED" + ], + "enumDescriptions": [ + "The protocol is not specified.", + "Internet protocol.", + "Virtual PDP type introduced to handle dual IP stack UE capability.", + "Internet protocol, version 6.", + "Transfer of Non-IP data to external packet data network.", + "Point to point protocol.", + "Transfer of Unstructured data to the Data Network via N6." + ], + "type": "string" + }, + "username": { + "description": "Optional. APN username of the APN.", + "type": "string" + } + }, + "type": "object" + }, "AppProcessInfo": { "description": "Information about a process. It contains process name, start time, app Uid, app Pid, seinfo tag, hash of the base APK.", "id": "AppProcessInfo", @@ -1861,6 +2129,28 @@ }, "type": "array" }, + "preferentialNetworkId": { + "description": "Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above.", + "enum": [ + "PREFERENTIAL_NETWORK_ID_UNSPECIFIED", + "NO_PREFERENTIAL_NETWORK", + "PREFERENTIAL_NETWORK_ID_ONE", + "PREFERENTIAL_NETWORK_ID_TWO", + "PREFERENTIAL_NETWORK_ID_THREE", + "PREFERENTIAL_NETWORK_ID_FOUR", + "PREFERENTIAL_NETWORK_ID_FIVE" + ], + "enumDescriptions": [ + "Whether this value is valid and what it means depends on where it is used, and this is documented on the relevant fields.", + "Application does not use any preferential network.", + "Preferential network identifier 1.", + "Preferential network identifier 2.", + "Preferential network identifier 3.", + "Preferential network identifier 4.", + "Preferential network identifier 5." + ], + "type": "string" + }, "userControlSettings": { "description": "Optional. Specifies whether user control is permitted for the app. User control includes user actions like force-stopping and clearing app data. Supported on Android 11 and above.", "enum": [ @@ -2287,7 +2577,8 @@ "RELINQUISH_OWNERSHIP", "CLEAR_APP_DATA", "START_LOST_MODE", - "STOP_LOST_MODE" + "STOP_LOST_MODE", + "REQUEST_DEVICE_INFO" ], "enumDescriptions": [ "This value is disallowed.", @@ -2297,7 +2588,8 @@ "Removes the work profile and all policies from a company-owned Android 8.0+ device, relinquishing the device for personal use. Apps and data associated with the personal profile(s) are preserved. The device will be deleted from the server after it acknowledges the command.", "Clears the application data of specified apps. This is supported on Android 9 and above. Note that an application can store data outside of its application data, for example in external storage or in a user dictionary. See also clear_apps_data_params.", "Puts the device into lost mode. Only supported on fully managed devices or organization-owned devices with a managed profile. See also start_lost_mode_params.", - "Takes the device out of lost mode. Only supported on fully managed devices or organization-owned devices with a managed profile. See also stop_lost_mode_params." + "Takes the device out of lost mode. Only supported on fully managed devices or organization-owned devices with a managed profile. See also stop_lost_mode_params.", + "Request information related to the device." ], "type": "string" }, @@ -2806,6 +3098,10 @@ "description": "Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more.", "id": "DeviceConnectivityManagement", "properties": { + "apnPolicy": { + "$ref": "ApnPolicy", + "description": "Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details." + }, "bluetoothSharing": { "description": "Optional. Controls whether Bluetooth sharing is allowed.", "enum": [ @@ -2836,6 +3132,10 @@ ], "type": "string" }, + "preferentialNetworkServiceSettings": { + "$ref": "PreferentialNetworkServiceSettings", + "description": "Optional. Preferential network service configuration. Setting this field will override preferentialNetworkService. This can be set on both work profiles and fully managed devices on Android 13 and above." + }, "tetheringSettings": { "description": "Controls tethering settings. Based on the value set, the user is partially or fully disallowed from using different forms of tethering.", "enum": [ @@ -4519,7 +4819,8 @@ "PENDING", "APP_INCOMPATIBLE", "APP_NOT_UPDATED", - "DEVICE_INCOMPATIBLE" + "DEVICE_INCOMPATIBLE", + "PROJECT_NOT_PERMITTED" ], "enumDescriptions": [ "This value is not used.", @@ -4533,7 +4834,8 @@ "The setting hasn't been applied at the time of the report, but is expected to be applied shortly.", "The setting can't be applied to the app because the app doesn't support it, for example because its target SDK version is not high enough.", "The app is installed, but it hasn't been updated to the minimum version code specified by policy.", - "The device is incompatible with the policy requirements." + "The device is incompatible with the policy requirements.", + "The Google Cloud Platform project used to manage the device is not permitted to use this policy." ], "type": "string" }, @@ -4560,7 +4862,8 @@ "ONC_WIFI_API_LEVEL", "ONC_WIFI_INVALID_ENTERPRISE_CONFIG", "ONC_WIFI_USER_SHOULD_REMOVE_NETWORK", - "ONC_WIFI_KEY_PAIR_ALIAS_NOT_CORRESPONDING_TO_EXISTING_KEY" + "ONC_WIFI_KEY_PAIR_ALIAS_NOT_CORRESPONDING_TO_EXISTING_KEY", + "PERMISSIBLE_USAGE_RESTRICTION" ], "enumDescriptions": [ "Specific non-compliance reason is not specified. Fields in specific_non_compliance_context are not set.", @@ -4571,7 +4874,8 @@ "The ONC Wi-Fi setting is not supported in the API level of the Android version running on the device. fieldPath specifies which field value is not supported. oncWifiContext is set. nonComplianceReason is set to API_LEVEL.", "The enterprise Wi-Fi network is missing either the root CA or domain name. nonComplianceReason is set to INVALID_VALUE.", "User needs to remove the configured Wi-Fi network manually. This is applicable only on work profiles on personally-owned devices. nonComplianceReason is set to USER_ACTION.", - "Key pair alias specified via ClientCertKeyPairAlias (https://chromium.googlesource.com/chromium/src/+/main/components/onc/docs/onc_spec.md#eap-type) field in openNetworkConfiguration does not correspond to an existing key installed on the device. nonComplianceReason is set to INVALID_VALUE." + "Key pair alias specified via ClientCertKeyPairAlias (https://chromium.googlesource.com/chromium/src/+/main/components/onc/docs/onc_spec.md#eap-type) field in openNetworkConfiguration does not correspond to an existing key installed on the device. nonComplianceReason is set to INVALID_VALUE.", + "This policy setting is restricted and cannot be set for this Google Cloud Platform project. More details (including how to enable usage of this policy setting) are available in the Permissible Usage policy (https://developers.google.com/android/management/permissible-usage). nonComplianceReason is set to PROJECT_NOT_PERMITTED." ], "type": "string" } @@ -4597,7 +4901,8 @@ "PENDING", "APP_INCOMPATIBLE", "APP_NOT_UPDATED", - "DEVICE_INCOMPATIBLE" + "DEVICE_INCOMPATIBLE", + "PROJECT_NOT_PERMITTED" ], "enumDescriptions": [ "This value is not used.", @@ -4611,7 +4916,8 @@ "The setting hasn't been applied at the time of the report, but is expected to be applied shortly.", "The setting can't be applied to the app because the app doesn't support it, for example because its target SDK version is not high enough.", "The app is installed, but it hasn't been updated to the minimum version code specified by policy.", - "The device is incompatible with the policy requirements." + "The device is incompatible with the policy requirements.", + "The Google Cloud Platform project used to manage the device is not permitted to use this policy." ], "type": "string" }, @@ -5331,6 +5637,20 @@ "description": "Whether app verification is force-enabled.", "type": "boolean" }, + "enterpriseDisplayNameVisibility": { + "description": "Optional. Controls whether the enterpriseDisplayName is visible on the device (e.g. lock screen message on company-owned devices).", + "enum": [ + "ENTERPRISE_DISPLAY_NAME_VISIBILITY_UNSPECIFIED", + "ENTERPRISE_DISPLAY_NAME_VISIBLE", + "ENTERPRISE_DISPLAY_NAME_HIDDEN" + ], + "enumDescriptions": [ + "Unspecified. Defaults to displaying the enterprise name that's set at the time of device setup. In future, this will default to ENTERPRISE_DISPLAY_NAME_VISIBLE.", + "The enterprise display name is visible on the device. Supported on work profiles on Android 7 and above. Supported on fully managed devices on Android 8 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 7. A nonComplianceDetail with MANAGEMENT_MODE is reported on fully managed devices on Android 7.", + "The enterprise display name is hidden on the device." + ], + "type": "string" + }, "factoryResetDisabled": { "description": "Whether factory resetting from settings is disabled.", "type": "boolean" @@ -5573,7 +5893,7 @@ "type": "array" }, "preferentialNetworkService": { - "description": "Controls whether preferential network service is enabled on the work profile. For example, an organization may have an agreement with a carrier that all of the work data from its employees' devices will be sent via a network service dedicated for enterprise use. An example of a supported preferential network service is the enterprise slice on 5G networks. This has no effect on fully managed devices.", + "description": "Controls whether preferential network service is enabled on the work profile or on fully managed devices. For example, an organization may have an agreement with a carrier that all of the work data from its employees' devices will be sent via a network service dedicated for enterprise use. An example of a supported preferential network service is the enterprise slice on 5G networks. This policy has no effect if preferentialNetworkServiceSettings or ApplicationPolicy.preferentialNetworkId is set on devices running Android 13 or above.", "enum": [ "PREFERENTIAL_NETWORK_SERVICE_UNSPECIFIED", "PREFERENTIAL_NETWORK_SERVICE_DISABLED", @@ -5582,7 +5902,7 @@ "enumDescriptions": [ "Unspecified. Defaults to PREFERENTIAL_NETWORK_SERVICES_DISABLED.", "Preferential network service is disabled on the work profile.", - "Preferential network service is enabled on the work profile." + "Preferential network service is enabled on the work profile. This setting is only supported on work profiles on devices running Android 12 or above. Starting with Android 13, fully managed devices are also supported." ], "type": "string" }, @@ -5824,6 +6144,99 @@ }, "type": "object" }, + "PreferentialNetworkServiceConfig": { + "description": "Individual preferential network service configuration.", + "id": "PreferentialNetworkServiceConfig", + "properties": { + "fallbackToDefaultConnection": { + "description": "Optional. Whether fallback to the device-wide default network is allowed. If this is set to FALLBACK_TO_DEFAULT_CONNECTION_ALLOWED, then nonMatchingNetworks must not be set to NON_MATCHING_NETWORKS_DISALLOWED, the policy will be rejected otherwise. Note: If this is set to FALLBACK_TO_DEFAULT_CONNECTION_DISALLOWED, applications are not able to access the internet if the 5G slice is not available.", + "enum": [ + "FALLBACK_TO_DEFAULT_CONNECTION_UNSPECIFIED", + "FALLBACK_TO_DEFAULT_CONNECTION_ALLOWED", + "FALLBACK_TO_DEFAULT_CONNECTION_DISALLOWED" + ], + "enumDescriptions": [ + "Unspecified. Defaults to FALLBACK_TO_DEFAULT_CONNECTION_ALLOWED.", + "Fallback to default connection is allowed. If this is set, nonMatchingNetworks must not be set to NON_MATCHING_NETWORKS_DISALLOWED, the policy will be rejected otherwise.", + "Fallback to default connection is not allowed." + ], + "type": "string" + }, + "nonMatchingNetworks": { + "description": "Optional. Whether apps this configuration applies to are blocked from using networks other than the preferential service. If this is set to NON_MATCHING_NETWORKS_DISALLOWED, then fallbackToDefaultConnection must be set to FALLBACK_TO_DEFAULT_CONNECTION_DISALLOWED.", + "enum": [ + "NON_MATCHING_NETWORKS_UNSPECIFIED", + "NON_MATCHING_NETWORKS_ALLOWED", + "NON_MATCHING_NETWORKS_DISALLOWED" + ], + "enumDescriptions": [ + "Unspecified. Defaults to NON_MATCHING_NETWORKS_ALLOWED.", + "Apps this configuration applies to are allowed to use networks other than the preferential service.", + "Apps this configuration applies to are disallowed from using other networks than the preferential service. This can be set on Android 14 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. If this is set, fallbackToDefaultConnection must be set to FALLBACK_TO_DEFAULT_CONNECTION_DISALLOWED, the policy will be rejected otherwise." + ], + "type": "string" + }, + "preferentialNetworkId": { + "description": "Required. Preferential network identifier. This must not be set to NO_PREFERENTIAL_NETWORK or PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the policy will be rejected otherwise.", + "enum": [ + "PREFERENTIAL_NETWORK_ID_UNSPECIFIED", + "NO_PREFERENTIAL_NETWORK", + "PREFERENTIAL_NETWORK_ID_ONE", + "PREFERENTIAL_NETWORK_ID_TWO", + "PREFERENTIAL_NETWORK_ID_THREE", + "PREFERENTIAL_NETWORK_ID_FOUR", + "PREFERENTIAL_NETWORK_ID_FIVE" + ], + "enumDescriptions": [ + "Whether this value is valid and what it means depends on where it is used, and this is documented on the relevant fields.", + "Application does not use any preferential network.", + "Preferential network identifier 1.", + "Preferential network identifier 2.", + "Preferential network identifier 3.", + "Preferential network identifier 4.", + "Preferential network identifier 5." + ], + "type": "string" + } + }, + "type": "object" + }, + "PreferentialNetworkServiceSettings": { + "description": "Preferential network service settings.", + "id": "PreferentialNetworkServiceSettings", + "properties": { + "defaultPreferentialNetworkId": { + "description": "Required. Default preferential network ID for the applications that are not in applications or if ApplicationPolicy.preferentialNetworkId is set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs, unless this is set to NO_PREFERENTIAL_NETWORK. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED or unset, this defaults to NO_PREFERENTIAL_NETWORK. Note: If the default preferential network is misconfigured, applications with no ApplicationPolicy.preferentialNetworkId set are not able to access the internet. This setting does not apply to the following critical apps: com.google.android.apps.work.clouddpc com.google.android.gmsApplicationPolicy.preferentialNetworkId can still be used to configure the preferential network for them.", + "enum": [ + "PREFERENTIAL_NETWORK_ID_UNSPECIFIED", + "NO_PREFERENTIAL_NETWORK", + "PREFERENTIAL_NETWORK_ID_ONE", + "PREFERENTIAL_NETWORK_ID_TWO", + "PREFERENTIAL_NETWORK_ID_THREE", + "PREFERENTIAL_NETWORK_ID_FOUR", + "PREFERENTIAL_NETWORK_ID_FIVE" + ], + "enumDescriptions": [ + "Whether this value is valid and what it means depends on where it is used, and this is documented on the relevant fields.", + "Application does not use any preferential network.", + "Preferential network identifier 1.", + "Preferential network identifier 2.", + "Preferential network identifier 3.", + "Preferential network identifier 4.", + "Preferential network identifier 5." + ], + "type": "string" + }, + "preferentialNetworkServiceConfigs": { + "description": "Required. Preferential network service configurations which enables having multiple enterprise slices. There must not be multiple configurations with the same preferentialNetworkId. If a configuration is not referenced by any application by setting ApplicationPolicy.preferentialNetworkId or by setting defaultPreferentialNetworkId, it will be ignored. For devices on 4G networks, enterprise APN needs to be configured additionally to set up data call for preferential network service. These APNs can be added using apnPolicy.", + "items": { + "$ref": "PreferentialNetworkServiceConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "ProvisioningInfo": { "description": "Information about a device that is available during setup.", "id": "ProvisioningInfo", diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 84068d2c25..c413902f34 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -2906,7 +2906,7 @@ "type": "string" }, "regionsVersion.version": { - "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.", + "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.", "location": "query", "type": "string" } @@ -3065,7 +3065,7 @@ "type": "string" }, "regionsVersion.version": { - "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.", + "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.", "location": "query", "type": "string" }, @@ -3527,7 +3527,7 @@ "type": "string" }, "regionsVersion.version": { - "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.", + "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.", "location": "query", "type": "string" } @@ -3784,7 +3784,7 @@ "type": "string" }, "regionsVersion.version": { - "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.", + "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.", "location": "query", "type": "string" }, @@ -3816,6 +3816,67 @@ }, "orders": { "methods": { + "batchget": { + "description": "Get order details for a list of orders.", + "flatPath": "androidpublisher/v3/applications/{packageName}/orders:batchGet", + "httpMethod": "GET", + "id": "androidpublisher.orders.batchget", + "parameterOrder": [ + "packageName" + ], + "parameters": { + "orderIds": { + "description": "Required. The list of order IDs to retrieve order details for. There must be between 1 and 1000 (inclusive) order IDs per request. If any order ID is not found or does not match the provided package, the entire request will fail with an error. The order IDs must be distinct.", + "location": "query", + "repeated": true, + "type": "string" + }, + "packageName": { + "description": "Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "androidpublisher/v3/applications/{packageName}/orders:batchGet", + "response": { + "$ref": "BatchGetOrdersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidpublisher" + ] + }, + "get": { + "description": "Get order details for a single order.", + "flatPath": "androidpublisher/v3/applications/{packageName}/orders/{orderId}", + "httpMethod": "GET", + "id": "androidpublisher.orders.get", + "parameterOrder": [ + "packageName", + "orderId" + ], + "parameters": { + "orderId": { + "description": "Required. The order ID provided to the user when the subscription or in-app order was purchased.", + "location": "path", + "required": true, + "type": "string" + }, + "packageName": { + "description": "Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "androidpublisher/v3/applications/{packageName}/orders/{orderId}", + "response": { + "$ref": "Order" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidpublisher" + ] + }, "refund": { "description": "Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.", "flatPath": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:refund", @@ -4732,7 +4793,7 @@ } } }, - "revision": "20250318", + "revision": "20250519", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -5380,6 +5441,20 @@ }, "type": "object" }, + "BatchGetOrdersResponse": { + "description": "Response for the orders.batchGet API.", + "id": "BatchGetOrdersResponse", + "properties": { + "orders": { + "description": "Details for the requested order IDs.", + "items": { + "$ref": "Order" + }, + "type": "array" + } + }, + "type": "object" + }, "BatchGetSubscriptionOffersRequest": { "description": "Request message for BatchGetSubscriptionOffers endpoint.", "id": "BatchGetSubscriptionOffersRequest", @@ -5599,6 +5674,25 @@ }, "type": "object" }, + "BuyerAddress": { + "description": "Address information for the customer, for use in tax computation.", + "id": "BuyerAddress", + "properties": { + "buyerCountry": { + "description": "Two letter country code based on ISO-3166-1 Alpha-2 (UN country codes).", + "type": "string" + }, + "buyerPostcode": { + "description": "Postal code of an address. When Google is the Merchant of Record for the order, this information is not included.", + "type": "string" + }, + "buyerState": { + "description": "Top-level administrative subdivision of the buyer address country. When Google is the Merchant of Record for the order, this information is not included.", + "type": "string" + } + }, + "type": "object" + }, "CancelAppRecoveryRequest": { "description": "Request message for CancelAppRecovery.", "id": "CancelAppRecoveryRequest", @@ -5665,6 +5759,18 @@ }, "type": "object" }, + "CancellationEvent": { + "description": "Details of when the order was canceled.", + "id": "CancellationEvent", + "properties": { + "eventTime": { + "description": "The time when the order was canceled.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "Comment": { "description": "An entry of conversation between user and developer.", "id": "Comment", @@ -7207,6 +7313,45 @@ }, "type": "object" }, + "LineItem": { + "description": "Details of a line item.", + "id": "LineItem", + "properties": { + "listingPrice": { + "$ref": "Money", + "description": "Item's listed price on Play Store, this may or may not include tax. Excludes any discounts or promotions." + }, + "oneTimePurchaseDetails": { + "$ref": "OneTimePurchaseDetails", + "description": "Details of a one-time purchase." + }, + "paidAppDetails": { + "$ref": "PaidAppDetails", + "description": "Details of a paid app purchase." + }, + "productId": { + "description": "The purchased product ID or in-app SKU (for example, 'monthly001' or 'com.some.thing.inapp1').", + "type": "string" + }, + "productTitle": { + "description": "Developer-specified name of the product. Displayed in buyer's locale. Example: coins, monthly subscription, etc.", + "type": "string" + }, + "subscriptionDetails": { + "$ref": "SubscriptionDetails", + "description": "Details of a subscription purchase." + }, + "tax": { + "$ref": "Money", + "description": "The tax paid for this line item." + }, + "total": { + "$ref": "Money", + "description": "The total amount paid by the user for this line item, taking into account discounts and tax." + } + }, + "type": "object" + }, "ListAppRecoveriesResponse": { "description": "Response message for ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled", "id": "ListAppRecoveriesResponse", @@ -7613,6 +7758,141 @@ }, "type": "object" }, + "OneTimePurchaseDetails": { + "description": "Details of a one-time purchase.", + "id": "OneTimePurchaseDetails", + "properties": { + "offerId": { + "description": "The offer ID of the one-time purchase offer.", + "type": "string" + }, + "quantity": { + "description": "The number of items purchased (for multi-quantity item purchases).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Order": { + "description": "Details of an order.", + "id": "Order", + "properties": { + "buyerAddress": { + "$ref": "BuyerAddress", + "description": "Address information for the customer, for use in tax computation. When Google is the Merchant of Record for the order, only country is shown." + }, + "createTime": { + "description": "The time when the order was created.", + "format": "google-datetime", + "type": "string" + }, + "developerRevenueInBuyerCurrency": { + "$ref": "Money", + "description": "Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees. Google deducts standard transaction and third party fees from each sale, including VAT in some regions." + }, + "lastEventTime": { + "description": "The time of the last event that occurred on the order.", + "format": "google-datetime", + "type": "string" + }, + "lineItems": { + "description": "The individual line items making up this order.", + "items": { + "$ref": "LineItem" + }, + "type": "array" + }, + "orderDetails": { + "$ref": "OrderDetails", + "description": "Detailed information about the order at creation time." + }, + "orderHistory": { + "$ref": "OrderHistory", + "description": "Details about events which modified the order." + }, + "orderId": { + "description": "The order ID.", + "type": "string" + }, + "pointsDetails": { + "$ref": "PointsDetails", + "description": "Play points applied to the order, including offer information, discount rate and point values." + }, + "purchaseToken": { + "description": "The token provided to the user's device when the subscription or item was purchased.", + "type": "string" + }, + "state": { + "description": "The state of the order.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "PROCESSED", + "CANCELED", + "PENDING_REFUND", + "PARTIALLY_REFUNDED", + "REFUNDED" + ], + "enumDescriptions": [ + "State unspecified. This value is not used.", + "Order has been created and is waiting to be processed.", + "Order has been successfully processed.", + "Order was canceled before being processed.", + "Requested refund is waiting to be processed.", + "Part of the order amount was refunded.", + "The full order amount was refunded." + ], + "type": "string" + }, + "tax": { + "$ref": "Money", + "description": "The total tax paid as a part of this order." + }, + "total": { + "$ref": "Money", + "description": "The final amount paid by the customer, taking into account discounts and taxes." + } + }, + "type": "object" + }, + "OrderDetails": { + "description": "Detailed information about the order at creation time.", + "id": "OrderDetails", + "properties": { + "taxInclusive": { + "description": "Indicates whether the listed price was tax inclusive or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "OrderHistory": { + "description": "Details about events which modified the order.", + "id": "OrderHistory", + "properties": { + "cancellationEvent": { + "$ref": "CancellationEvent", + "description": "Details of when the order was canceled." + }, + "partialRefundEvents": { + "description": "Details of the partial refund events for this order.", + "items": { + "$ref": "PartialRefundEvent" + }, + "type": "array" + }, + "processedEvent": { + "$ref": "ProcessedEvent", + "description": "Details of when the order was processed." + }, + "refundEvent": { + "$ref": "RefundEvent", + "description": "Details of when the order was fully refunded." + } + }, + "type": "object" + }, "OtherRecurringProduct": { "description": "Details of a recurring external transaction product which doesn't belong to any other more specific category.", "id": "OtherRecurringProduct", @@ -7716,6 +7996,12 @@ }, "type": "object" }, + "PaidAppDetails": { + "description": "Details of a paid app purchase.", + "id": "PaidAppDetails", + "properties": {}, + "type": "object" + }, "PartialRefund": { "description": "A partial refund of a transaction.", "id": "PartialRefund", @@ -7731,6 +8017,41 @@ }, "type": "object" }, + "PartialRefundEvent": { + "description": "Details of the partial refund events for this order.", + "id": "PartialRefundEvent", + "properties": { + "createTime": { + "description": "The time when the partial refund was created.", + "format": "google-datetime", + "type": "string" + }, + "processTime": { + "description": "The time when the partial refund was processed.", + "format": "google-datetime", + "type": "string" + }, + "refundDetails": { + "$ref": "RefundDetails", + "description": "Details for the partial refund." + }, + "state": { + "description": "The state of the partial refund.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "PROCESSED_SUCCESSFULLY" + ], + "enumDescriptions": [ + "State unspecified. This value is not used.", + "The partial refund has been created, but not yet processed.", + "The partial refund was processed successfully." + ], + "type": "string" + } + }, + "type": "object" + }, "PausedStateContext": { "description": "Information specific to a subscription in paused state.", "id": "PausedStateContext", @@ -7749,6 +8070,31 @@ "properties": {}, "type": "object" }, + "PointsDetails": { + "description": "Details relating to any Play Points applied to an order.", + "id": "PointsDetails", + "properties": { + "pointsCouponValue": { + "$ref": "Money", + "description": "The monetary value of a Play Points coupon. This is the discount the coupon provides, which may not be the total amount. Only set when Play Points coupons have been used. E.g. for a 100 points for $2 coupon, this is $2." + }, + "pointsDiscountRateMicros": { + "description": "The percentage rate which the Play Points promotion reduces the cost by. E.g. for a 100 points for $2 coupon, this is 500,000. Since $2 has an estimate of 200 points, but the actual Points required, 100, is 50% of this, and 50% in micros is 500,000. Between 0 and 1,000,000.", + "format": "int64", + "type": "string" + }, + "pointsOfferId": { + "description": "ID unique to the play points offer in use for this order.", + "type": "string" + }, + "pointsSpent": { + "description": "The number of Play Points applied in this order. E.g. for a 100 points for $2 coupon, this is 100. For coupon stacked with base offer, this is the total points spent across both.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "PrepaidBasePlanType": { "description": "Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user.", "id": "PrepaidBasePlanType", @@ -7801,6 +8147,18 @@ }, "type": "object" }, + "ProcessedEvent": { + "description": "Details of when the order was processed.", + "id": "ProcessedEvent", + "properties": { + "eventTime": { + "description": "The time when the order was processed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "ProductPurchase": { "description": "A ProductPurchase resource indicates the status of a user's inapp product purchase.", "id": "ProductPurchase", @@ -7923,6 +8281,51 @@ }, "type": "object" }, + "RefundDetails": { + "description": "Details for a partial or full refund.", + "id": "RefundDetails", + "properties": { + "tax": { + "$ref": "Money", + "description": "The amount of tax refunded." + }, + "total": { + "$ref": "Money", + "description": "The total amount refunded, including tax." + } + }, + "type": "object" + }, + "RefundEvent": { + "description": "Details of when the order was fully refunded.", + "id": "RefundEvent", + "properties": { + "eventTime": { + "description": "The time when the order was fully refunded.", + "format": "google-datetime", + "type": "string" + }, + "refundDetails": { + "$ref": "RefundDetails", + "description": "Details for the full refund." + }, + "refundReason": { + "description": "The reason the order was refunded.", + "enum": [ + "REFUND_REASON_UNSPECIFIED", + "OTHER", + "CHARGEBACK" + ], + "enumDescriptions": [ + "Refund reason unspecified. This value is not used.", + "The order was refunded for a reason other than the listed reasons here.", + "The order was charged back." + ], + "type": "string" + } + }, + "type": "object" + }, "RefundExternalTransactionRequest": { "description": "A request to refund an existing external transaction.", "id": "RefundExternalTransactionRequest", @@ -8113,7 +8516,7 @@ "id": "RegionsVersion", "properties": { "version": { - "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.", + "description": "Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.", "type": "string" } }, @@ -8275,6 +8678,10 @@ "$ref": "RevocationContextFullRefund", "description": "Optional. Used when users should be refunded the full amount of the latest order of the subscription." }, + "itemBasedRefund": { + "$ref": "RevocationContextItemBasedRefund", + "description": "Optional. Used when a specific item should be refunded in a subscription with multiple items." + }, "proratedRefund": { "$ref": "RevocationContextProratedRefund", "description": "Optional. Used when users should be refunded a prorated amount they paid for their subscription based on the amount of time remaining in a subscription." @@ -8288,6 +8695,17 @@ "properties": {}, "type": "object" }, + "RevocationContextItemBasedRefund": { + "description": "Used to determine what specific item to revoke in a subscription with multiple items.", + "id": "RevocationContextItemBasedRefund", + "properties": { + "productId": { + "description": "Required. If the subscription is a subscription bundle, the product id of the subscription to revoke.", + "type": "string" + } + }, + "type": "object" + }, "RevocationContextProratedRefund": { "description": "Used to determine if the refund type in the RevocationContext is a prorated refund.", "id": "RevocationContextProratedRefund", @@ -8590,6 +9008,47 @@ }, "type": "object" }, + "SubscriptionDetails": { + "description": "Details of a subscription purchase.", + "id": "SubscriptionDetails", + "properties": { + "basePlanId": { + "description": "The base plan ID of the subscription.", + "type": "string" + }, + "offerId": { + "description": "The offer ID for the current subscription offer.", + "type": "string" + }, + "offerPhase": { + "description": "The pricing phase for the billing period funded by this order.", + "enum": [ + "OFFER_PHASE_UNSPECIFIED", + "BASE", + "INTRODUCTORY", + "FREE_TRIAL" + ], + "enumDescriptions": [ + "Offer phase unspecified. This value is not used.", + "The order funds a base price period.", + "The order funds an introductory pricing period.", + "The order funds a free trial period." + ], + "type": "string" + }, + "servicePeriodEndTime": { + "description": "The end of the billing period funded by this order. This is a snapshot of the billing/service period end time at the moment the order was processed, and should be used only for accounting. To get the current end time of the subscription service period, use purchases.subscriptionsv2.get.", + "format": "google-datetime", + "type": "string" + }, + "servicePeriodStartTime": { + "description": "The start of the billing period funded by this order. This is a snapshot of the billing/service period start time at the moment the order was processed, and should be used only for accounting.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "SubscriptionItemPriceChangeDetails": { "description": "Price change related information of a subscription item.", "id": "SubscriptionItemPriceChangeDetails", diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 0e4fccb203..6175831769 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -2173,7 +2173,7 @@ "keys": { "methods": { "create": { - "description": "Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the ProductizeAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.", + "description": "Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.", "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys", "httpMethod": "POST", "id": "apigee.organizations.appgroups.apps.keys.create", @@ -2251,7 +2251,7 @@ ] }, "updateAppGroupAppKey": { - "description": "Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to the AppGroupAppKey. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.", + "description": "Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes and scopes to the AppGroupAppKey. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.", "flatPath": "v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}", "httpMethod": "POST", "id": "apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey", @@ -3402,7 +3402,7 @@ ] }, "updateDeveloperAppKey": { - "description": "Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to a developer app key. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. You can use the same key to access all API products associated with the app.", + "description": "Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes and scopes associated with the API product to the developer app key. The status of the key can be updated via \"action\" Query Parameter. None of the other fields can be updated via this API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. None of the other fields can be updated. You can use the same key to access all API products associated with the app.", "flatPath": "v1/organizations/{organizationsId}/developers/{developersId}/apps/{appsId}/keys/{keysId}", "httpMethod": "POST", "id": "apigee.organizations.developers.apps.keys.updateDeveloperAppKey", @@ -11063,7 +11063,7 @@ } } }, - "revision": "20250425", + "revision": "20250519", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -17136,7 +17136,7 @@ "type": "string" }, "consumptionPricingRates": { - "description": "API call volume ranges and the fees charged when the total number of API calls is within a given range. The method used to calculate the final fee depends on the selected pricing model. For example, if the pricing model is `STAIRSTEP` and the ranges are defined as follows: ``` { \"start\": 1, \"end\": 100, \"fee\": 75 }, { \"start\": 101, \"end\": 200, \"fee\": 100 }, } ``` Then the following fees would be charged based on the total number of API calls (assuming the currency selected is `USD`): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200.", + "description": "API call volume ranges and the fees charged when the total number of API calls is within a given range. The method used to calculate the final fee depends on the selected pricing model. For example, if the pricing model is `BANDED` and the ranges are defined as follows: ``` { \"start\": 1, \"end\": 100, \"fee\": 2 }, { \"start\": 101, \"end\": 200, \"fee\": 1.50 }, { \"start\": 201, \"end\": 0, \"fee\": 1 }, } ``` Then the following fees would be charged based on the total number of API calls (assuming the currency selected is `USD`): * 50 calls cost 50 x $2 = $100 * 150 calls cost 100 x $2 + 50 x $1.5 = $275 * 250 calls cost 100 x $2 + 100 x $1.5 + 50 x $1 = $400 * 500 calls cost 100 x $2 + 100 x $1.5 + 300 x $1 = $650", "items": { "$ref": "GoogleCloudApigeeV1RateRange" }, @@ -17154,7 +17154,7 @@ "enumDescriptions": [ "Pricing model not specified. This is the default.", "Fixed rate charged for each API call.", - "Variable rate charged for each API call based on price tiers. Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 per call * 201-300 calls cost $1 per call * Total price for 50 calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + 50 x $1 = $400. **Note**: Not supported by Apigee at this time.", + "Variable rate charged for each API call based on price tiers. Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 per call * 201-300 calls cost $1 per call * Total price for 50 calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + 50 x $1 = $400.", "**Note**: Not supported by Apigee at this time.", "**Note**: Not supported by Apigee at this time." ], @@ -19547,7 +19547,7 @@ }, "appGroupAppKey": { "$ref": "GoogleCloudApigeeV1AppGroupAppKey", - "description": "The new AppGroupKey to be amended. Note that the status can be updated only via action." + "description": "Note that only Scopes and Attributes of the AppGroupAppKey can be amended." } }, "type": "object" diff --git a/discovery/apihub-v1.json b/discovery/apihub-v1.json new file mode 100644 index 0000000000..46eccb9a9e --- /dev/null +++ b/discovery/apihub-v1.json @@ -0,0 +1,5865 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://apihub.googleapis.com/", + "batchPath": "batch", + "canonicalName": "API hub", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "apihub:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://apihub.mtls.googleapis.com/", + "name": "apihub", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "collectApiData": { + "description": "Collect API data from a source and push it to Hub's collect layer.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:collectApiData", + "httpMethod": "POST", + "id": "apihub.projects.locations.collectApiData", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The regional location of the API hub instance and its resources. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:collectApiData", + "request": { + "$ref": "GoogleCloudApihubV1CollectApiDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudLocationLocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "apihub.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "GoogleCloudLocationListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "lookupRuntimeProjectAttachment": { + "description": "Look up a runtime project attachment. This API can be called in the context of any project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupRuntimeProjectAttachment", + "httpMethod": "GET", + "id": "apihub.projects.locations.lookupRuntimeProjectAttachment", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:lookupRuntimeProjectAttachment", + "response": { + "$ref": "GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchResources": { + "description": "Search across API-Hub resources.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchResources", + "httpMethod": "POST", + "id": "apihub.projects.locations.searchResources", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the location which will be of the type `projects/{project_id}/locations/{location_id}`. This field is used to identify the instance of API-Hub in which resources should be searched.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:searchResources", + "request": { + "$ref": "GoogleCloudApihubV1SearchResourcesRequest" + }, + "response": { + "$ref": "GoogleCloudApihubV1SearchResourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "apiHubInstances": { + "methods": { + "create": { + "description": "Provisions instance resources for the API Hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances", + "httpMethod": "POST", + "id": "apihub.projects.locations.apiHubInstances.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "apiHubInstanceId": { + "description": "Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are `/a-z[0-9]-_/`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for the Api Hub instance resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apiHubInstances", + "request": { + "$ref": "GoogleCloudApihubV1ApiHubInstance" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the API hub instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances/{apiHubInstancesId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.apiHubInstances.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Api Hub instance to delete. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apiHubInstances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single API Hub instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances/{apiHubInstancesId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.apiHubInstances.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Api Hub instance to retrieve. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apiHubInstances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1ApiHubInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "lookup": { + "description": "Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apiHubInstances:lookup", + "httpMethod": "GET", + "id": "apihub.projects.locations.apiHubInstances.lookup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. There will always be only one Api Hub instance for a GCP project across all locations. The parent resource for the Api Hub instance resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apiHubInstances:lookup", + "response": { + "$ref": "GoogleCloudApihubV1LookupApiHubInstanceResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "apis": { + "methods": { + "create": { + "description": "Create an API resource in the API hub. Once an API resource is created, versions can be added to it.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis", + "httpMethod": "POST", + "id": "apihub.projects.locations.apis.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "apiId": { + "description": "Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for the API resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apis", + "request": { + "$ref": "GoogleCloudApihubV1Api" + }, + "response": { + "$ref": "GoogleCloudApihubV1Api" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.apis.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the API resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get API resource details including the API versions contained in it.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1Api" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List API resources in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of ApiResources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not case sensitive. The following fields in the `ApiResource` are eligible for filtering: * `owner.email` - The email of the team which owns the ApiResource. Allowed comparison operators: `=`. * `create_time` - The time at which the ApiResource was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `display_name` - The display name of the ApiResource. Allowed comparison operators: `=`. * `target_user.enum_values.values.id` - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `target_user.enum_values.values.display_name` - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.id` - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.display_name` - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.id` - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.display_name` - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.id` - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.display_name` - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.id` - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.display_name` - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `owner.email = \\\"apihub@google.com\\\"` - - The owner team email is _apihub@google.com_. * `owner.email = \\\"apihub@google.com\\\" AND create_time < \\\"2021-08-15T14:50:00Z\\\" AND create_time > \\\"2021-08-10T12:00:00Z\\\"` - The owner team email is _apihub@google.com_ and the api was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `owner.email = \\\"apihub@google.com\\\" OR team.enum_values.values.id: apihub-team-id` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is _apihub-team-id_. * `owner.email = \\\"apihub@google.com\\\" OR team.enum_values.values.display_name: ApiHub Team` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is `ApiHub Team`. * `owner.email = \\\"apihub@google.com\\\" AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test_enum_id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/1765\\0f90-4a29-5431-b3d0-d5532da3764c.string_values.values: test_string_value` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ and the id of the allowed value associated with the user defined attribute of type enum is _test_enum_id_ and the value of the user defined attribute of type string is _test_..", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListApis` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of API resources. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apis", + "response": { + "$ref": "GoogleCloudApihubV1ListApisResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.apis.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1Api" + }, + "response": { + "$ref": "GoogleCloudApihubV1Api" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "versions": { + "methods": { + "create": { + "description": "Create an API version for an API resource in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions", + "httpMethod": "POST", + "id": "apihub.projects.locations.apis.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource for API version. Format: `projects/{project}/locations/{location}/apis/{api}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + }, + "versionId": { + "description": "Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another version in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}`, its length is limited to 700 characters and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/versions", + "request": { + "$ref": "GoogleCloudApihubV1Version" + }, + "response": { + "$ref": "GoogleCloudApihubV1Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.apis.versions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, any specs from this version will also be deleted. Otherwise, the request will only work if the version has no specs.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the version to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the API version to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List API versions of an API resource in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of Versions. 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 `=`. Filters are not case sensitive. The following fields in the `Version` are eligible for filtering: * `display_name` - The display name of the Version. Allowed comparison operators: `=`. * `create_time` - The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `lifecycle.enum_values.values.id` - The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`. * `lifecycle.enum_values.values.display_name` - The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`. * `compliance.enum_values.values.id` - The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators: `:`. * `compliance.enum_values.values.display_name` - The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators: `:`. * `accreditation.enum_values.values.id` - The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. * `accreditation.enum_values.values.display_name` - The allowed value display name of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `lifecycle.enum_values.values.id: preview-id` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_. * `lifecycle.enum_values.values.display_name: \\\"Preview Display Name\\\"` - The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version is `Preview Display Name`. * `lifecycle.enum_values.values.id: preview-id AND create_time < \\\"2021-08-15T14:50:00Z\\\" AND create_time > \\\"2021-08-10T12:00:00Z\\\"` - The id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_ and it was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id` - The id of the allowed value associated with the compliance attribute is _gdpr-id_ or _pci-dss-id_. * `lifecycle.enum_values.values.id: preview-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_ and the value of the user defined attribute of type string is _test_.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListVersions` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent which owns this collection of API versions i.e., the API resource Format: `projects/{project}/locations/{location}/apis/{api}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/versions", + "response": { + "$ref": "GoogleCloudApihubV1ListVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update API version. The following fields in the version can be updated currently: * display_name * description * documentation * deployments * lifecycle * compliance * accreditation * attributes The update_mask should be used to specify the fields being updated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.apis.versions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1Version" + }, + "response": { + "$ref": "GoogleCloudApihubV1Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "definitions": { + "methods": { + "get": { + "description": "Get details about a definition in an API version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/definitions/{definitionsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.versions.definitions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the definition to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/definitions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1Definition" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "create": { + "description": "Create an apiOperation in an API version. An apiOperation can be created only if the version has no apiOperations which were created by parsing a spec.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations", + "httpMethod": "POST", + "id": "apihub.projects.locations.apis.versions.operations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "apiOperationId": { + "description": "Optional. The ID to use for the operation resource, which will become the final component of the operation's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another operation resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`, its length is limited to 700 characters, and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for the operation resource. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/operations", + "request": { + "$ref": "GoogleCloudApihubV1ApiOperation" + }, + "response": { + "$ref": "GoogleCloudApihubV1ApiOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete an operation in an API version and we can delete only the operations created via create API. If the operation was created by parsing the spec, then it can be deleted by editing or deleting the spec.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.apis.versions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the operation resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get details about a particular operation in API version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.versions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the operation to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1ApiOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List operations in an API version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.versions.operations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of ApiOperations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `ApiOperation` are eligible for filtering: * `name` - The ApiOperation resource name. Allowed comparison operators: `=`. * `details.http_operation.path.path` - The http operation's complete path relative to server endpoint. Allowed comparison operators: `=`. * `details.http_operation.method` - The http operation method type. Allowed comparison operators: `=`. * `details.deprecated` - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: `=`. * `create_time` - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `details.deprecated = True` - The ApiOperation is deprecated. * `details.http_operation.method = GET AND create_time < \\\"2021-08-15T14:50:00Z\\\" AND create_time > \\\"2021-08-10T12:00:00Z\\\"` - The method of the http operation of the ApiOperation is _GET_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `details.http_operation.method = GET OR details.http_operation.method = POST`. - The http operation of the method of ApiOperation is _GET_ or _POST_. * `details.deprecated = True AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the ApiOperation is deprecated and the value of the user defined attribute of type string is _test_.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListApiOperations` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent which owns this collection of operations i.e., the API version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/operations", + "response": { + "$ref": "GoogleCloudApihubV1ListApiOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations/{operationsId}", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.apis.versions.operations.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1ApiOperation" + }, + "response": { + "$ref": "GoogleCloudApihubV1ApiOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "specs": { + "methods": { + "create": { + "description": "Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the `projects/{project}/locations/{location}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs", + "httpMethod": "POST", + "id": "apihub.projects.locations.apis.versions.specs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource for Spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "specId": { + "description": "Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another spec in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/specs", + "request": { + "$ref": "GoogleCloudApihubV1Spec" + }, + "response": { + "$ref": "GoogleCloudApihubV1Spec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a spec. Deleting a spec will also delete the associated operations from the version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.apis.versions.specs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the spec to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.versions.specs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1Spec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getContents": { + "description": "Get spec contents.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:contents", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.versions.specs.getContents", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the spec whose contents need to be retrieved. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:contents", + "response": { + "$ref": "GoogleCloudApihubV1SpecContents" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "lint": { + "description": "Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:lint", + "httpMethod": "POST", + "id": "apihub.projects.locations.apis.versions.specs.lint", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the spec to be linted. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:lint", + "request": { + "$ref": "GoogleCloudApihubV1LintSpecRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List specs corresponding to a particular API resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs", + "httpMethod": "GET", + "id": "apihub.projects.locations.apis.versions.specs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not case sensitive. The following fields in the `Spec` are eligible for filtering: * `display_name` - The display name of the Spec. Allowed comparison operators: `=`. * `create_time` - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `spec_type.enum_values.values.id` - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `spec_type.enum_values.values.display_name` - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `lint_response.json_values.values` - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: `:`. * `mime_type` - The MIME type of the Spec. Allowed comparison operators: `=`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `spec_type.enum_values.values.id: rest-id` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_. * `spec_type.enum_values.values.display_name: \\\"Rest Display Name\\\"` - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is `Rest Display Name`. * `spec_type.enum_values.values.id: grpc-id AND create_time < \\\"2021-08-15T14:50:00Z\\\" AND create_time > \\\"2021-08-10T12:00:00Z\\\"` - The id of the allowed value associated with the spec_type attribute is _grpc-id_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `spec_type.enum_values.values.id: rest-id OR spec_type.enum_values.values.id: grpc-id` - The id of the allowed value associated with the spec_type attribute is _rest-id_ or _grpc-id_. * `spec_type.enum_values.values.id: rest-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_ and the id of the allowed value associated with the user defined attribute of type enum is _test_.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSpecs` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of specs. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/specs", + "response": { + "$ref": "GoogleCloudApihubV1ListSpecsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The update_mask should be used to specify the fields being updated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.apis.versions.specs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1Spec" + }, + "response": { + "$ref": "GoogleCloudApihubV1Spec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "attributes": { + "methods": { + "create": { + "description": "Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as `SYSTEM_DEFINED` and can be listed via ListAttributes method. Allowed values for the same can be updated via UpdateAttribute method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/attributes", + "httpMethod": "POST", + "id": "apihub.projects.locations.attributes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "attributeId": { + "description": "Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another attribute resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for Attribute. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/attributes", + "request": { + "$ref": "GoogleCloudApihubV1Attribute" + }, + "response": { + "$ref": "GoogleCloudApihubV1Attribute" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/attributes/{attributesId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.attributes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the attribute to delete. Format: `projects/{project}/locations/{location}/attributes/{attribute}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/attributes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get details about the attribute.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/attributes/{attributesId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.attributes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the attribute to retrieve. Format: `projects/{project}/locations/{location}/attributes/{attribute}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/attributes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1Attribute" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List all attributes.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/attributes", + "httpMethod": "GET", + "id": "apihub.projects.locations.attributes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of Attributes. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Attribute` are eligible for filtering: * `display_name` - The display name of the Attribute. Allowed comparison operators: `=`. * `definition_type` - The definition type of the attribute. Allowed comparison operators: `=`. * `scope` - The scope of the attribute. Allowed comparison operators: `=`. * `data_type` - The type of the data of the attribute. Allowed comparison operators: `=`. * `mandatory` - Denotes whether the attribute is mandatory or not. Allowed comparison operators: `=`. * `create_time` - The time at which the Attribute was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `display_name = production` - - The display name of the attribute is _production_. * `(display_name = production) AND (create_time < \\\"2021-08-15T14:50:00Z\\\") AND (create_time > \\\"2021-08-10T12:00:00Z\\\")` - The display name of the attribute is _production_ and the attribute was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `display_name = production OR scope = api` - The attribute where the display name is _production_ or the scope is _api_.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of attribute resources to return. The service may return fewer than this value. If unspecified, at most 50 attributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListAttributes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAttributes` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for Attribute. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/attributes", + "response": { + "$ref": "GoogleCloudApihubV1ListAttributesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update the attribute. The following fields in the Attribute resource can be updated: * display_name The display name can be updated for user defined attributes only. * description The description can be updated for user defined attributes only. * allowed_values To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted. * cardinality The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update. The update_mask should be used to specify the fields being updated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/attributes/{attributesId}", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.attributes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/attributes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1Attribute" + }, + "response": { + "$ref": "GoogleCloudApihubV1Attribute" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "curations": { + "methods": { + "create": { + "description": "Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/curations", + "httpMethod": "POST", + "id": "apihub.projects.locations.curations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "curationId": { + "description": "Optional. The ID to use for the curation resource, which will become the final component of the curations's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub. * If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for the curation resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/curations", + "request": { + "$ref": "GoogleCloudApihubV1Curation" + }, + "response": { + "$ref": "GoogleCloudApihubV1Curation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/curations/{curationsId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.curations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the curation resource to delete. Format: `projects/{project}/locations/{location}/curations/{curation}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/curations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get curation resource details.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/curations/{curationsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.curations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the curation resource to retrieve. Format: `projects/{project}/locations/{location}/curations/{curation}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/curations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1Curation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List curation resources in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/curations", + "httpMethod": "GET", + "id": "apihub.projects.locations.curations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of curation resources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are case insensitive. The following fields in the `curation resource` are eligible for filtering: * `create_time` - The time at which the curation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `display_name` - The display name of the curation. Allowed comparison operators: `=`. * `state` - The state of the curation. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `create_time < \\\"2021-08-15T14:50:00Z\\\" AND create_time > \\\"2021-08-10T12:00:00Z\\\"` - The curation resource was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of curation resources to return. The service may return fewer than this value. If unspecified, at most 50 curations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListCurations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListCurations` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of curation resources. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/curations", + "response": { + "$ref": "GoogleCloudApihubV1ListCurationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a curation resource in the API hub. The following fields in the curation can be updated: * display_name * description The update_mask should be used to specify the fields being updated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/curations/{curationsId}", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.curations.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/curations/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1Curation" + }, + "response": { + "$ref": "GoogleCloudApihubV1Curation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "dependencies": { + "methods": { + "create": { + "description": "Create a dependency between two entities in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dependencies", + "httpMethod": "POST", + "id": "apihub.projects.locations.dependencies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "dependencyId": { + "description": "Optional. The ID to use for the dependency resource, which will become the final component of the dependency's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if duplicate id is provided by the client. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are `a-z[0-9]-_`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for the dependency resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dependencies", + "request": { + "$ref": "GoogleCloudApihubV1Dependency" + }, + "response": { + "$ref": "GoogleCloudApihubV1Dependency" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete the dependency resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dependencies/{dependenciesId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.dependencies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the dependency resource to delete. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dependencies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get details about a dependency resource in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dependencies/{dependenciesId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.dependencies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the dependency resource to retrieve. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dependencies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1Dependency" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List dependencies based on the provided filter and pagination parameters.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dependencies", + "httpMethod": "GET", + "id": "apihub.projects.locations.dependencies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of Dependencies. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. Allowed comparison operator is `=`. Filters are not case sensitive. The following fields in the `Dependency` are eligible for filtering: * `consumer.operation_resource_name` - The operation resource name for the consumer entity involved in a dependency. Allowed comparison operators: `=`. * `consumer.external_api_resource_name` - The external api resource name for the consumer entity involved in a dependency. Allowed comparison operators: `=`. * `supplier.operation_resource_name` - The operation resource name for the supplier entity involved in a dependency. Allowed comparison operators: `=`. * `supplier.external_api_resource_name` - The external api resource name for the supplier entity involved in a dependency. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. For example, `consumer.operation_resource_name = \\\"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\\\" OR supplier.operation_resource_name = \\\"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\\\"` - The dependencies with either consumer or supplier operation resource name as _projects/p1/locations/global/apis/a1/versions/v1/operations/o1_.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of dependency resources to return. The service may return fewer than this value. If unspecified, at most 50 dependencies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListDependencies` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDependencies` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent which owns this collection of dependency resources. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dependencies", + "response": { + "$ref": "GoogleCloudApihubV1ListDependenciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a dependency based on the update_mask provided in the request. The following fields in the dependency can be updated: * description", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dependencies/{dependenciesId}", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.dependencies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dependencies/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1Dependency" + }, + "response": { + "$ref": "GoogleCloudApihubV1Dependency" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "deployments": { + "methods": { + "create": { + "description": "Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments", + "httpMethod": "POST", + "id": "apihub.projects.locations.deployments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deploymentId": { + "description": "Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another deployment resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for the deployment resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/deployments", + "request": { + "$ref": "GoogleCloudApihubV1Deployment" + }, + "response": { + "$ref": "GoogleCloudApihubV1Deployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a deployment resource in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.deployments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment resource to delete. Format: `projects/{project}/locations/{location}/deployments/{deployment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get details about a deployment and the API versions linked to it.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.deployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment resource to retrieve. Format: `projects/{project}/locations/{location}/deployments/{deployment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1Deployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List deployment resources in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments", + "httpMethod": "GET", + "id": "apihub.projects.locations.deployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of Deployments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Deployments` are eligible for filtering: * `display_name` - The display name of the Deployment. Allowed comparison operators: `=`. * `create_time` - The time at which the Deployment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `resource_uri` - A URI to the deployment resource. Allowed comparison operators: `=`. * `api_versions` - The API versions linked to this deployment. Allowed comparison operators: `:`. * `deployment_type.enum_values.values.id` - The allowed value id of the deployment_type attribute associated with the Deployment. Allowed comparison operators: `:`. * `deployment_type.enum_values.values.display_name` - The allowed value display name of the deployment_type attribute associated with the Deployment. Allowed comparison operators: `:`. * `slo.string_values.values` -The allowed string value of the slo attribute associated with the deployment. Allowed comparison operators: `:`. * `environment.enum_values.values.id` - The allowed value id of the environment attribute associated with the deployment. Allowed comparison operators: `:`. * `environment.enum_values.values.display_name` - The allowed value display name of the environment attribute associated with the deployment. Allowed comparison operators: `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `environment.enum_values.values.id: staging-id` - The allowed value id of the environment attribute associated with the Deployment is _staging-id_. * `environment.enum_values.values.display_name: \\\"Staging Deployment\\\"` - The allowed value display name of the environment attribute associated with the Deployment is `Staging Deployment`. * `environment.enum_values.values.id: production-id AND create_time < \\\"2021-08-15T14:50:00Z\\\" AND create_time > \\\"2021-08-10T12:00:00Z\\\"` - The allowed value id of the environment attribute associated with the Deployment is _production-id_ and Deployment was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `environment.enum_values.values.id: production-id OR slo.string_values.values: \\\"99.99%\\\"` - The allowed value id of the environment attribute Deployment is _production-id_ or string value of the slo attribute is _99.99%_. * `environment.enum_values.values.id: staging-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the allowed value id of the environment attribute associated with the Deployment is _staging-id_ and the value of the user defined attribute of type string is _test_.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of deployment resources to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListDeployments` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of deployment resources. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/deployments", + "response": { + "$ref": "GoogleCloudApihubV1ListDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a deployment resource in the API hub. The following fields in the deployment resource can be updated: * display_name * description * documentation * deployment_type * resource_uri * endpoints * slo * environment * attributes The update_mask should be used to specify the fields being updated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.deployments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1Deployment" + }, + "response": { + "$ref": "GoogleCloudApihubV1Deployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "externalApis": { + "methods": { + "create": { + "description": "Create an External API resource in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/externalApis", + "httpMethod": "POST", + "id": "apihub.projects.locations.externalApis.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "externalApiId": { + "description": "Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for the External API resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/externalApis", + "request": { + "$ref": "GoogleCloudApihubV1ExternalApi" + }, + "response": { + "$ref": "GoogleCloudApihubV1ExternalApi" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete an External API resource in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.externalApis.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the External API resource to delete. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/externalApis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get details about an External API resource in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.externalApis.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the External API resource to retrieve. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/externalApis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1ExternalApi" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List External API resources in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/externalApis", + "httpMethod": "GET", + "id": "apihub.projects.locations.externalApis.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of External API resources to return. The service may return fewer than this value. If unspecified, at most 50 ExternalApis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListExternalApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListExternalApis` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of External API resources. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/externalApis", + "response": { + "$ref": "GoogleCloudApihubV1ListExternalApisResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update an External API resource in the API hub. The following fields can be updated: * display_name * description * documentation * endpoints * paths The update_mask should be used to specify the fields being updated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/externalApis/{externalApisId}", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.externalApis.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/externalApis/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1ExternalApi" + }, + "response": { + "$ref": "GoogleCloudApihubV1ExternalApi" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "hostProjectRegistrations": { + "methods": { + "create": { + "description": "Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hostProjectRegistrations", + "httpMethod": "POST", + "id": "apihub.projects.locations.hostProjectRegistrations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "hostProjectRegistrationId": { + "description": "Required. The ID to use for the Host Project Registration, which will become the final component of the host project registration's resource name. The ID must be the same as the Google cloud project specified in the host_project_registration.gcp_project field.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource for the host project. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/hostProjectRegistrations", + "request": { + "$ref": "GoogleCloudApihubV1HostProjectRegistration" + }, + "response": { + "$ref": "GoogleCloudApihubV1HostProjectRegistration" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a host project registration.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hostProjectRegistrations/{hostProjectRegistrationsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.hostProjectRegistrations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Host project registration resource name. projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hostProjectRegistrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1HostProjectRegistration" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists host project registrations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hostProjectRegistrations", + "httpMethod": "GET", + "id": "apihub.projects.locations.hostProjectRegistrations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of HostProjectRegistrations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `HostProjectRegistration` are eligible for filtering: * `name` - The name of the HostProjectRegistration. * `create_time` - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * `gcp_project` - The Google cloud project associated with the HostProjectRegistration.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of host project registrations to return. The service may return fewer than this value. If unspecified, at most 50 host project registrations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListHostProjectRegistrations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListHostProjectRegistrations` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of host projects. Format: `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/hostProjectRegistrations", + "response": { + "$ref": "GoogleCloudApihubV1ListHostProjectRegistrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "apihub.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleLongrunningCancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "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}/operations", + "httpMethod": "GET", + "id": "apihub.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "plugins": { + "methods": { + "create": { + "description": "Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins", + "httpMethod": "POST", + "id": "apihub.projects.locations.plugins.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pluginId": { + "description": "Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/plugins/{plugin}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/plugins", + "request": { + "$ref": "GoogleCloudApihubV1Plugin" + }, + "response": { + "$ref": "GoogleCloudApihubV1Plugin" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.plugins.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Plugin resource to delete. Format: `projects/{project}/locations/{location}/plugins/{plugin}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "disable": { + "description": "Disables a plugin. The `state` of the plugin after disabling is `DISABLED`", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}:disable", + "httpMethod": "POST", + "id": "apihub.projects.locations.plugins.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the plugin to disable. Format: `projects/{project}/locations/{location}/plugins/{plugin}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:disable", + "request": { + "$ref": "GoogleCloudApihubV1DisablePluginRequest" + }, + "response": { + "$ref": "GoogleCloudApihubV1Plugin" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "enable": { + "description": "Enables a plugin. The `state` of the plugin after enabling is `ENABLED`", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}:enable", + "httpMethod": "POST", + "id": "apihub.projects.locations.plugins.enable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the plugin to enable. Format: `projects/{project}/locations/{location}/plugins/{plugin}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:enable", + "request": { + "$ref": "GoogleCloudApihubV1EnablePluginRequest" + }, + "response": { + "$ref": "GoogleCloudApihubV1Plugin" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get an API Hub plugin.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.plugins.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the plugin to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1Plugin" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getStyleGuide": { + "description": "Get the style guide being used for linting.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/styleGuide", + "httpMethod": "GET", + "id": "apihub.projects.locations.plugins.getStyleGuide", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/styleGuide$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1StyleGuide" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List all the plugins in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins", + "httpMethod": "GET", + "id": "apihub.projects.locations.plugins.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of plugins. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Plugins` are eligible for filtering: * `plugin_category` - The category of the Plugin. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `plugin_category = ON_RAMP` - The plugin is of category on ramp.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListPlugins` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListPlugins` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/plugins", + "response": { + "$ref": "GoogleCloudApihubV1ListPluginsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateStyleGuide": { + "description": "Update the styleGuide to be used for liniting in by API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/styleGuide", + "httpMethod": "PATCH", + "id": "apihub.projects.locations.plugins.updateStyleGuide", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the style guide. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/styleGuide$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApihubV1StyleGuide" + }, + "response": { + "$ref": "GoogleCloudApihubV1StyleGuide" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "instances": { + "methods": { + "create": { + "description": "Creates a Plugin instance in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances", + "httpMethod": "POST", + "id": "apihub.projects.locations.plugins.instances.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+$", + "required": true, + "type": "string" + }, + "pluginInstanceId": { + "description": "Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another plugin instance in the plugin resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/instances", + "request": { + "$ref": "GoogleCloudApihubV1PluginInstance" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a plugin instance in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.plugins.instances.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the plugin instance to delete. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "disableAction": { + "description": "Disables a plugin instance in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:disableAction", + "httpMethod": "POST", + "id": "apihub.projects.locations.plugins.instances.disableAction", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the plugin instance to disable. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:disableAction", + "request": { + "$ref": "GoogleCloudApihubV1DisablePluginInstanceActionRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "enableAction": { + "description": "Enables a plugin instance in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:enableAction", + "httpMethod": "POST", + "id": "apihub.projects.locations.plugins.instances.enableAction", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the plugin instance to enable. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:enableAction", + "request": { + "$ref": "GoogleCloudApihubV1EnablePluginInstanceActionRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeAction": { + "description": "Executes a plugin instance in the API hub.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}:executeAction", + "httpMethod": "POST", + "id": "apihub.projects.locations.plugins.instances.executeAction", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the plugin instance to execute. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeAction", + "request": { + "$ref": "GoogleCloudApihubV1ExecutePluginInstanceActionRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get an API Hub plugin instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.plugins.instances.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the plugin instance to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1PluginInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List all the plugins in a given project and location. `-` can be used as wildcard value for {plugin_id}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances", + "httpMethod": "GET", + "id": "apihub.projects.locations.plugins.instances.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of plugin instances. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `PluginInstances` are eligible for filtering: * `state` - The state of the Plugin Instance. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `state = ENABLED` - The plugin instance is in enabled state.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListPluginInstances` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluginInstances` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}/plugins/{plugin}`. To list plugin instances for multiple plugins, use the - character instead of the plugin ID.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/instances", + "response": { + "$ref": "GoogleCloudApihubV1ListPluginInstancesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "styleGuide": { + "methods": { + "getContents": { + "description": "Get the contents of the style guide.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/styleGuide:contents", + "httpMethod": "GET", + "id": "apihub.projects.locations.plugins.styleGuide.getContents", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/styleGuide$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:contents", + "response": { + "$ref": "GoogleCloudApihubV1StyleGuideContents" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "runtimeProjectAttachments": { + "methods": { + "create": { + "description": "Attaches a runtime project to the host project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments", + "httpMethod": "POST", + "id": "apihub.projects.locations.runtimeProjectAttachments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource for the Runtime Project Attachment. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "runtimeProjectAttachmentId": { + "description": "Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment's name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/runtimeProjectAttachments", + "request": { + "$ref": "GoogleCloudApihubV1RuntimeProjectAttachment" + }, + "response": { + "$ref": "GoogleCloudApihubV1RuntimeProjectAttachment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments/{runtimeProjectAttachmentsId}", + "httpMethod": "DELETE", + "id": "apihub.projects.locations.runtimeProjectAttachments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Runtime Project Attachment to delete. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/runtimeProjectAttachments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a runtime project attachment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments/{runtimeProjectAttachmentsId}", + "httpMethod": "GET", + "id": "apihub.projects.locations.runtimeProjectAttachments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/runtimeProjectAttachments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApihubV1RuntimeProjectAttachment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List runtime projects attached to the host project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtimeProjectAttachments", + "httpMethod": "GET", + "id": "apihub.projects.locations.runtimeProjectAttachments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression that filters the list of RuntimeProjectAttachments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `RuntimeProjectAttachment` are eligible for filtering: * `name` - The name of the RuntimeProjectAttachment. * `create_time` - The time at which the RuntimeProjectAttachment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * `runtime_project` - The Google cloud project associated with the RuntimeProjectAttachment.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of runtime project attachments to return. The service may return fewer than this value. If unspecified, at most 50 runtime project attachments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListRuntimeProjectAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListRuntimeProjectAttachments` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of runtime project attachments. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/runtimeProjectAttachments", + "response": { + "$ref": "GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20250324", + "rootUrl": "https://apihub.googleapis.com/", + "schemas": { + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "GoogleCloudApihubV1APIMetadata": { + "description": "The API metadata.", + "id": "GoogleCloudApihubV1APIMetadata", + "properties": { + "api": { + "$ref": "GoogleCloudApihubV1Api", + "description": "Required. The API resource to be pushed to Hub's collect layer. The ID of the API resource will be generated by Hub to ensure uniqueness across all APIs across systems." + }, + "originalCreateTime": { + "description": "Optional. Timestamp indicating when the API was created at the source.", + "format": "google-datetime", + "type": "string" + }, + "originalId": { + "description": "Optional. The unique identifier of the API in the system where it was originally created.", + "type": "string" + }, + "originalUpdateTime": { + "description": "Required. Timestamp indicating when the API was last updated at the source.", + "format": "google-datetime", + "type": "string" + }, + "versions": { + "description": "Optional. The list of versions present in an API resource.", + "items": { + "$ref": "GoogleCloudApihubV1VersionMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ActionExecutionDetail": { + "description": "The details for the action to execute.", + "id": "GoogleCloudApihubV1ActionExecutionDetail", + "properties": { + "actionId": { + "description": "Required. The action id of the plugin to execute.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1AllowedValue": { + "description": "The value that can be assigned to the attribute when the data type is enum.", + "id": "GoogleCloudApihubV1AllowedValue", + "properties": { + "description": { + "description": "Optional. The detailed description of the allowed value.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the allowed value.", + "type": "string" + }, + "id": { + "description": "Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.", + "type": "string" + }, + "immutable": { + "description": "Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Api": { + "description": "An API resource in the API Hub.", + "id": "GoogleCloudApihubV1Api", + "properties": { + "apiFunctionalRequirements": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute." + }, + "apiRequirements": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute." + }, + "apiStyle": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "apiTechnicalRequirements": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute." + }, + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudApihubV1AttributeValues" + }, + "description": "Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.", + "type": "object" + }, + "businessUnit": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "createTime": { + "description": "Output only. The time at which the API resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the API resource.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the API resource.", + "type": "string" + }, + "documentation": { + "$ref": "GoogleCloudApihubV1Documentation", + "description": "Optional. The documentation for the API resource." + }, + "fingerprint": { + "description": "Optional. Fingerprint of the API resource.", + "type": "string" + }, + "maturityLevel": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "name": { + "description": "Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`", + "type": "string" + }, + "owner": { + "$ref": "GoogleCloudApihubV1Owner", + "description": "Optional. Owner details for the API resource." + }, + "selectedVersion": { + "description": "Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "type": "string" + }, + "sourceMetadata": { + "description": "Output only. The list of sources and metadata from the sources of the API resource.", + "items": { + "$ref": "GoogleCloudApihubV1SourceMetadata" + }, + "readOnly": true, + "type": "array" + }, + "targetUser": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "team": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "updateTime": { + "description": "Output only. The time at which the API resource was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "versions": { + "description": "Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ApiData": { + "description": "The API data to be collected.", + "id": "GoogleCloudApihubV1ApiData", + "properties": { + "apiMetadataList": { + "$ref": "GoogleCloudApihubV1ApiMetadataList", + "description": "Optional. The list of API metadata." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ApiHubInstance": { + "description": "An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.", + "id": "GoogleCloudApihubV1ApiHubInstance", + "properties": { + "config": { + "$ref": "GoogleCloudApihubV1Config", + "description": "Required. Config of the ApiHub instance." + }, + "createTime": { + "description": "Output only. Creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the ApiHub instance.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources", + "type": "object" + }, + "name": { + "description": "Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the ApiHub instance.", + "enum": [ + "STATE_UNSPECIFIED", + "INACTIVE", + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "FAILED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The ApiHub instance has not been initialized or has been deleted.", + "The ApiHub instance is being created.", + "The ApiHub instance has been created and is ready for use.", + "The ApiHub instance is being updated.", + "The ApiHub instance is being deleted.", + "The ApiHub instance encountered an error during a state change." + ], + "readOnly": true, + "type": "string" + }, + "stateMessage": { + "description": "Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last update timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ApiHubResource": { + "description": "ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub.", + "id": "GoogleCloudApihubV1ApiHubResource", + "properties": { + "api": { + "$ref": "GoogleCloudApihubV1Api", + "description": "This represents Api resource in search results. Only name, display_name, description and owner fields are populated in search results." + }, + "definition": { + "$ref": "GoogleCloudApihubV1Definition", + "description": "This represents Definition resource in search results. Only name field is populated in search results." + }, + "deployment": { + "$ref": "GoogleCloudApihubV1Deployment", + "description": "This represents Deployment resource in search results. Only name, display_name, description, deployment_type and api_versions fields are populated in search results." + }, + "operation": { + "$ref": "GoogleCloudApihubV1ApiOperation", + "description": "This represents ApiOperation resource in search results. Only name, description, spec and details fields are populated in search results." + }, + "spec": { + "$ref": "GoogleCloudApihubV1Spec", + "description": "This represents Spec resource in search results. Only name, display_name, description, spec_type and documentation fields are populated in search results." + }, + "version": { + "$ref": "GoogleCloudApihubV1Version", + "description": "This represents Version resource in search results. Only name, display_name, description, lifecycle, compliance and accreditation fields are populated in search results." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ApiKeyConfig": { + "description": "Config for authentication with API key.", + "id": "GoogleCloudApihubV1ApiKeyConfig", + "properties": { + "apiKey": { + "$ref": "GoogleCloudApihubV1Secret", + "description": "Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret." + }, + "httpElementLocation": { + "description": "Required. The location of the API key. The default value is QUERY.", + "enum": [ + "HTTP_ELEMENT_LOCATION_UNSPECIFIED", + "QUERY", + "HEADER", + "PATH", + "BODY", + "COOKIE" + ], + "enumDescriptions": [ + "HTTP element location not specified.", + "Element is in the HTTP request query.", + "Element is in the HTTP request header.", + "Element is in the HTTP request path.", + "Element is in the HTTP request body.", + "Element is in the HTTP request cookie." + ], + "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" + }, + "GoogleCloudApihubV1ApiMetadataList": { + "description": "The message to hold repeated API metadata.", + "id": "GoogleCloudApihubV1ApiMetadataList", + "properties": { + "apiMetadata": { + "description": "Required. The list of API metadata.", + "items": { + "$ref": "GoogleCloudApihubV1APIMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ApiOperation": { + "description": "Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.", + "id": "GoogleCloudApihubV1ApiOperation", + "properties": { + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudApihubV1AttributeValues" + }, + "description": "Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.", + "type": "object" + }, + "createTime": { + "description": "Output only. The time at which the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "details": { + "$ref": "GoogleCloudApihubV1OperationDetails", + "description": "Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided." + }, + "name": { + "description": "Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`", + "type": "string" + }, + "sourceMetadata": { + "description": "Output only. The list of sources and metadata from the sources of the API operation.", + "items": { + "$ref": "GoogleCloudApihubV1SourceMetadata" + }, + "readOnly": true, + "type": "array" + }, + "spec": { + "description": "Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time at which the operation was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ApplicationIntegrationEndpointDetails": { + "description": "The details of the Application Integration endpoint to be triggered for curation.", + "id": "GoogleCloudApihubV1ApplicationIntegrationEndpointDetails", + "properties": { + "triggerId": { + "description": "Required. The API trigger ID of the Application Integration workflow.", + "type": "string" + }, + "uri": { + "description": "Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Attribute": { + "description": "An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.", + "id": "GoogleCloudApihubV1Attribute", + "properties": { + "allowedValues": { + "description": "Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.", + "items": { + "$ref": "GoogleCloudApihubV1AllowedValue" + }, + "type": "array" + }, + "cardinality": { + "description": "Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.", + "format": "int32", + "type": "integer" + }, + "createTime": { + "description": "Output only. The time at which the attribute was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataType": { + "description": "Required. The type of the data of the attribute.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "ENUM", + "JSON", + "STRING", + "URI" + ], + "enumDescriptions": [ + "Attribute data type unspecified.", + "Attribute's value is of type enum.", + "Attribute's value is of type json.", + "Attribute's value is of type string.", + "Attribute's value is of type uri." + ], + "type": "string" + }, + "definitionType": { + "description": "Output only. The definition type of the attribute.", + "enum": [ + "DEFINITION_TYPE_UNSPECIFIED", + "SYSTEM_DEFINED", + "USER_DEFINED" + ], + "enumDescriptions": [ + "Attribute definition type unspecified.", + "The attribute is predefined by the API Hub. Note that only the list of allowed values can be updated in this case via UpdateAttribute method.", + "The attribute is defined by the user." + ], + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the attribute.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the attribute.", + "type": "string" + }, + "mandatory": { + "description": "Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`", + "type": "string" + }, + "scope": { + "description": "Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.", + "enum": [ + "SCOPE_UNSPECIFIED", + "API", + "VERSION", + "SPEC", + "API_OPERATION", + "DEPLOYMENT", + "DEPENDENCY", + "DEFINITION", + "EXTERNAL_API", + "PLUGIN" + ], + "enumDescriptions": [ + "Scope Unspecified.", + "Attribute can be linked to an API.", + "Attribute can be linked to an API version.", + "Attribute can be linked to a Spec.", + "Attribute can be linked to an API Operation.", + "Attribute can be linked to a Deployment.", + "Attribute can be linked to a Dependency.", + "Attribute can be linked to a definition.", + "Attribute can be linked to a ExternalAPI.", + "Attribute can be linked to a Plugin." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The time at which the attribute was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1AttributeValues": { + "description": "The attribute values associated with resource.", + "id": "GoogleCloudApihubV1AttributeValues", + "properties": { + "attribute": { + "description": "Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}", + "readOnly": true, + "type": "string" + }, + "enumValues": { + "$ref": "GoogleCloudApihubV1EnumAttributeValues", + "description": "The attribute values associated with a resource in case attribute data type is enum." + }, + "jsonValues": { + "$ref": "GoogleCloudApihubV1StringAttributeValues", + "description": "The attribute values associated with a resource in case attribute data type is JSON." + }, + "stringValues": { + "$ref": "GoogleCloudApihubV1StringAttributeValues", + "description": "The attribute values associated with a resource in case attribute data type is string." + }, + "uriValues": { + "$ref": "GoogleCloudApihubV1StringAttributeValues", + "description": "The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1AuthConfig": { + "description": "AuthConfig represents the authentication information.", + "id": "GoogleCloudApihubV1AuthConfig", + "properties": { + "apiKeyConfig": { + "$ref": "GoogleCloudApihubV1ApiKeyConfig", + "description": "Api Key Config." + }, + "authType": { + "description": "Required. The authentication type.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "NO_AUTH", + "GOOGLE_SERVICE_ACCOUNT", + "USER_PASSWORD", + "API_KEY", + "OAUTH2_CLIENT_CREDENTIALS" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "No authentication.", + "Google service account authentication.", + "Username and password authentication.", + "API Key authentication.", + "Oauth 2.0 client credentials grant authentication." + ], + "type": "string" + }, + "googleServiceAccountConfig": { + "$ref": "GoogleCloudApihubV1GoogleServiceAccountConfig", + "description": "Google Service Account." + }, + "oauth2ClientCredentialsConfig": { + "$ref": "GoogleCloudApihubV1Oauth2ClientCredentialsConfig", + "description": "Oauth2.0 Client Credentials." + }, + "userPasswordConfig": { + "$ref": "GoogleCloudApihubV1UserPasswordConfig", + "description": "User Password." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1AuthConfigTemplate": { + "description": "AuthConfigTemplate represents the authentication template for a plugin.", + "id": "GoogleCloudApihubV1AuthConfigTemplate", + "properties": { + "serviceAccount": { + "$ref": "GoogleCloudApihubV1GoogleServiceAccountConfig", + "description": "Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account." + }, + "supportedAuthTypes": { + "description": "Required. The list of authentication types supported by the plugin.", + "items": { + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "NO_AUTH", + "GOOGLE_SERVICE_ACCOUNT", + "USER_PASSWORD", + "API_KEY", + "OAUTH2_CLIENT_CREDENTIALS" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "No authentication.", + "Google service account authentication.", + "Username and password authentication.", + "API Key authentication.", + "Oauth 2.0 client credentials grant authentication." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1CollectApiDataRequest": { + "description": "The CollectApiData method's request.", + "id": "GoogleCloudApihubV1CollectApiDataRequest", + "properties": { + "actionId": { + "description": "Required. The action ID to be used for collecting the API data. This should map to one of the action IDs specified in action configs in the plugin.", + "type": "string" + }, + "apiData": { + "$ref": "GoogleCloudApihubV1ApiData", + "description": "Required. The API data to be collected." + }, + "collectionType": { + "description": "Required. The type of collection. Applies to all entries in api_data.", + "enum": [ + "COLLECTION_TYPE_UNSPECIFIED", + "COLLECTION_TYPE_UPSERT", + "COLLECTION_TYPE_DELETE" + ], + "enumDescriptions": [ + "The default value. This value is used if the collection type is omitted.", + "The collection type is upsert. This should be used when an API is created or updated at the source.", + "The collection type is delete. This should be used when an API is deleted at the source." + ], + "type": "string" + }, + "pluginInstance": { + "description": "Required. The plugin instance collecting the API data. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Config": { + "description": "Available configurations to provision an ApiHub Instance.", + "id": "GoogleCloudApihubV1Config", + "properties": { + "cmekKeyName": { + "description": "Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.", + "type": "string" + }, + "disableSearch": { + "description": "Optional. If true, the search will be disabled for the instance. The default value is false.", + "type": "boolean" + }, + "encryptionType": { + "description": "Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used.", + "enum": [ + "ENCRYPTION_TYPE_UNSPECIFIED", + "GMEK", + "CMEK" + ], + "enumDescriptions": [ + "Encryption type unspecified.", + "Default encryption using Google managed encryption key.", + "Encryption using customer managed encryption key." + ], + "type": "string" + }, + "vertexLocation": { + "description": "Optional. The name of the Vertex AI location where the data store is stored.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ConfigTemplate": { + "description": "ConfigTemplate represents the configuration template for a plugin.", + "id": "GoogleCloudApihubV1ConfigTemplate", + "properties": { + "additionalConfigTemplate": { + "description": "Optional. The list of additional configuration variables for the plugin's configuration.", + "items": { + "$ref": "GoogleCloudApihubV1ConfigVariableTemplate" + }, + "type": "array" + }, + "authConfigTemplate": { + "$ref": "GoogleCloudApihubV1AuthConfigTemplate", + "description": "Optional. The authentication template for the plugin." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ConfigValueOption": { + "description": "ConfigValueOption represents an option for a config variable of type enum or multi select.", + "id": "GoogleCloudApihubV1ConfigValueOption", + "properties": { + "description": { + "description": "Optional. Description of the option.", + "type": "string" + }, + "displayName": { + "description": "Required. Display name of the option.", + "type": "string" + }, + "id": { + "description": "Required. Id of the option.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ConfigVariable": { + "description": "ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.", + "id": "GoogleCloudApihubV1ConfigVariable", + "properties": { + "boolValue": { + "description": "Optional. The config variable value in case of config variable of type boolean.", + "type": "boolean" + }, + "enumValue": { + "$ref": "GoogleCloudApihubV1ConfigValueOption", + "description": "Optional. The config variable value in case of config variable of type enum." + }, + "intValue": { + "description": "Optional. The config variable value in case of config variable of type integer.", + "format": "int64", + "type": "string" + }, + "key": { + "description": "Output only. Key will be the id to uniquely identify the config variable.", + "readOnly": true, + "type": "string" + }, + "multiIntValues": { + "$ref": "GoogleCloudApihubV1MultiIntValues", + "description": "Optional. The config variable value in case of config variable of type multi integer." + }, + "multiSelectValues": { + "$ref": "GoogleCloudApihubV1MultiSelectValues", + "description": "Optional. The config variable value in case of config variable of type multi select." + }, + "multiStringValues": { + "$ref": "GoogleCloudApihubV1MultiStringValues", + "description": "Optional. The config variable value in case of config variable of type multi string." + }, + "secretValue": { + "$ref": "GoogleCloudApihubV1Secret", + "description": "Optional. The config variable value in case of config variable of type secret." + }, + "stringValue": { + "description": "Optional. The config variable value in case of config variable of type string.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ConfigVariableTemplate": { + "description": "ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.", + "id": "GoogleCloudApihubV1ConfigVariableTemplate", + "properties": { + "description": { + "description": "Optional. Description.", + "type": "string" + }, + "enumOptions": { + "description": "Optional. Enum options. To be populated if `ValueType` is `ENUM`.", + "items": { + "$ref": "GoogleCloudApihubV1ConfigValueOption" + }, + "type": "array" + }, + "id": { + "description": "Required. ID of the config variable. Must be unique within the configuration.", + "type": "string" + }, + "multiSelectOptions": { + "description": "Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT`.", + "items": { + "$ref": "GoogleCloudApihubV1ConfigValueOption" + }, + "type": "array" + }, + "required": { + "description": "Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance.", + "type": "boolean" + }, + "validationRegex": { + "description": "Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.", + "type": "string" + }, + "valueType": { + "description": "Required. Type of the parameter: string, int, bool etc.", + "enum": [ + "VALUE_TYPE_UNSPECIFIED", + "STRING", + "INT", + "BOOL", + "SECRET", + "ENUM", + "MULTI_SELECT", + "MULTI_STRING", + "MULTI_INT" + ], + "enumDescriptions": [ + "Value type is not specified.", + "Value type is string.", + "Value type is integer.", + "Value type is boolean.", + "Value type is secret.", + "Value type is enum.", + "Value type is multi select.", + "Value type is multi string.", + "Value type is multi int." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Curation": { + "description": "A curation resource in the API Hub.", + "id": "GoogleCloudApihubV1Curation", + "properties": { + "createTime": { + "description": "Output only. The time at which the curation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the curation.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the curation.", + "type": "string" + }, + "endpoint": { + "$ref": "GoogleCloudApihubV1Endpoint", + "description": "Required. The endpoint to be triggered for curation." + }, + "lastExecutionErrorCode": { + "description": "Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.", + "enum": [ + "ERROR_CODE_UNSPECIFIED", + "INTERNAL_ERROR", + "UNAUTHORIZED" + ], + "enumDescriptions": [ + "Default unspecified error code.", + "The execution failed due to an internal error.", + "The curation is not authorized to trigger the endpoint uri." + ], + "readOnly": true, + "type": "string" + }, + "lastExecutionErrorMessage": { + "description": "Output only. Error message describing the failure, if any, during the last execution of the curation.", + "readOnly": true, + "type": "string" + }, + "lastExecutionState": { + "description": "Output only. The last execution state of the curation.", + "enum": [ + "LAST_EXECUTION_STATE_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Default unspecified state.", + "The last curation execution was successful.", + "The last curation execution failed." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`", + "type": "string" + }, + "pluginInstanceActions": { + "description": "Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.", + "items": { + "$ref": "GoogleCloudApihubV1PluginInstanceActionID" + }, + "readOnly": true, + "type": "array" + }, + "updateTime": { + "description": "Output only. The time at which the curation was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1CurationConfig": { + "description": "The curation information for this plugin instance.", + "id": "GoogleCloudApihubV1CurationConfig", + "properties": { + "curationType": { + "description": "Required. The curation type for this plugin instance.", + "enum": [ + "CURATION_TYPE_UNSPECIFIED", + "DEFAULT_CURATION_FOR_API_METADATA", + "CUSTOM_CURATION_FOR_API_METADATA" + ], + "enumDescriptions": [ + "Default unspecified curation type.", + "Default curation for API metadata will be used.", + "Custom curation for API metadata will be used." + ], + "type": "string" + }, + "customCuration": { + "$ref": "GoogleCloudApihubV1CustomCuration", + "description": "Optional. Custom curation information for this plugin instance." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1CustomCuration": { + "description": "Custom curation information for this plugin instance.", + "id": "GoogleCloudApihubV1CustomCuration", + "properties": { + "curation": { + "description": "Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Definition": { + "description": "Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only `schema` object is supported.", + "id": "GoogleCloudApihubV1Definition", + "properties": { + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudApihubV1AttributeValues" + }, + "description": "Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.", + "type": "object" + }, + "createTime": { + "description": "Output only. The time at which the definition was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the definition. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`", + "type": "string" + }, + "schema": { + "$ref": "GoogleCloudApihubV1Schema", + "description": "Output only. The value of a schema definition.", + "readOnly": true + }, + "spec": { + "description": "Output only. The name of the spec from where the definition was parsed. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of the definition.", + "enum": [ + "TYPE_UNSPECIFIED", + "SCHEMA" + ], + "enumDescriptions": [ + "Definition type unspecified.", + "Definition type schema." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time at which the definition was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Dependency": { + "description": "A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.", + "id": "GoogleCloudApihubV1Dependency", + "properties": { + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudApihubV1AttributeValues" + }, + "description": "Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.", + "type": "object" + }, + "consumer": { + "$ref": "GoogleCloudApihubV1DependencyEntityReference", + "description": "Required. Immutable. The entity acting as the consumer in the dependency." + }, + "createTime": { + "description": "Output only. The time at which the dependency was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Human readable description corresponding of the dependency.", + "type": "string" + }, + "discoveryMode": { + "description": "Output only. Discovery mode of the dependency.", + "enum": [ + "DISCOVERY_MODE_UNSPECIFIED", + "MANUAL" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Manual mode of discovery when the dependency is defined by the user." + ], + "readOnly": true, + "type": "string" + }, + "errorDetail": { + "$ref": "GoogleCloudApihubV1DependencyErrorDetail", + "description": "Output only. Error details of a dependency if the system has detected it internally.", + "readOnly": true + }, + "name": { + "description": "Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`", + "type": "string" + }, + "state": { + "description": "Output only. State of the dependency.", + "enum": [ + "STATE_UNSPECIFIED", + "PROPOSED", + "VALIDATED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Dependency will be in a proposed state when it is newly identified by the API hub on its own.", + "Dependency will be in a validated state when it is validated by the admin or manually created in the API hub." + ], + "readOnly": true, + "type": "string" + }, + "supplier": { + "$ref": "GoogleCloudApihubV1DependencyEntityReference", + "description": "Required. Immutable. The entity acting as the supplier in the dependency." + }, + "updateTime": { + "description": "Output only. The time at which the dependency was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1DependencyEntityReference": { + "description": "Reference to an entity participating in a dependency.", + "id": "GoogleCloudApihubV1DependencyEntityReference", + "properties": { + "displayName": { + "description": "Output only. Display name of the entity.", + "readOnly": true, + "type": "string" + }, + "externalApiResourceName": { + "description": "The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`", + "type": "string" + }, + "operationResourceName": { + "description": "The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1DependencyErrorDetail": { + "description": "Details describing error condition of a dependency.", + "id": "GoogleCloudApihubV1DependencyErrorDetail", + "properties": { + "error": { + "description": "Optional. Error in the dependency.", + "enum": [ + "ERROR_UNSPECIFIED", + "SUPPLIER_NOT_FOUND", + "SUPPLIER_RECREATED" + ], + "enumDescriptions": [ + "Default value used for no error in the dependency.", + "Supplier entity has been deleted.", + "Supplier entity has been recreated." + ], + "type": "string" + }, + "errorTime": { + "description": "Optional. Timestamp at which the error was found.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Deployment": { + "description": "Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.", + "id": "GoogleCloudApihubV1Deployment", + "properties": { + "apiVersions": { + "description": "Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudApihubV1AttributeValues" + }, + "description": "Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.", + "type": "object" + }, + "createTime": { + "description": "Output only. The time at which the deployment was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deploymentType": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "description": { + "description": "Optional. The description of the deployment.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the deployment.", + "type": "string" + }, + "documentation": { + "$ref": "GoogleCloudApihubV1Documentation", + "description": "Optional. The documentation of the deployment." + }, + "endpoints": { + "description": "Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.", + "items": { + "type": "string" + }, + "type": "array" + }, + "environment": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "name": { + "description": "Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`", + "type": "string" + }, + "resourceUri": { + "description": "Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.", + "type": "string" + }, + "slo": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "sourceMetadata": { + "description": "Output only. The list of sources and metadata from the sources of the deployment.", + "items": { + "$ref": "GoogleCloudApihubV1SourceMetadata" + }, + "readOnly": true, + "type": "array" + }, + "updateTime": { + "description": "Output only. The time at which the deployment was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1DeploymentMetadata": { + "description": "The metadata associated with a deployment.", + "id": "GoogleCloudApihubV1DeploymentMetadata", + "properties": { + "deployment": { + "$ref": "GoogleCloudApihubV1Deployment", + "description": "Required. The deployment resource to be pushed to Hub's collect layer. The ID of the deployment will be generated by Hub." + }, + "originalCreateTime": { + "description": "Optional. Timestamp indicating when the deployment was created at the source.", + "format": "google-datetime", + "type": "string" + }, + "originalId": { + "description": "Optional. The unique identifier of the deployment in the system where it was originally created.", + "type": "string" + }, + "originalUpdateTime": { + "description": "Required. Timestamp indicating when the deployment was last updated at the source.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1DisablePluginInstanceActionRequest": { + "description": "The DisablePluginInstanceAction method's request.", + "id": "GoogleCloudApihubV1DisablePluginInstanceActionRequest", + "properties": { + "actionId": { + "description": "Required. The action id to disable.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1DisablePluginRequest": { + "description": "The DisablePlugin method's request.", + "id": "GoogleCloudApihubV1DisablePluginRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudApihubV1Documentation": { + "description": "Documentation details.", + "id": "GoogleCloudApihubV1Documentation", + "properties": { + "externalUri": { + "description": "Optional. The uri of the externally hosted documentation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1EnablePluginInstanceActionRequest": { + "description": "The EnablePluginInstanceAction method's request.", + "id": "GoogleCloudApihubV1EnablePluginInstanceActionRequest", + "properties": { + "actionId": { + "description": "Required. The action id to enable.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1EnablePluginRequest": { + "description": "The EnablePlugin method's request.", + "id": "GoogleCloudApihubV1EnablePluginRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudApihubV1Endpoint": { + "description": "The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata.", + "id": "GoogleCloudApihubV1Endpoint", + "properties": { + "applicationIntegrationEndpointDetails": { + "$ref": "GoogleCloudApihubV1ApplicationIntegrationEndpointDetails", + "description": "Required. The details of the Application Integration endpoint to be triggered for curation." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1EnumAttributeValues": { + "description": "The attribute values of data type enum.", + "id": "GoogleCloudApihubV1EnumAttributeValues", + "properties": { + "values": { + "description": "Required. The attribute values in case attribute data type is enum.", + "items": { + "$ref": "GoogleCloudApihubV1AllowedValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ExecutePluginInstanceActionRequest": { + "description": "The ExecutePluginInstanceAction method's request.", + "id": "GoogleCloudApihubV1ExecutePluginInstanceActionRequest", + "properties": { + "actionExecutionDetail": { + "$ref": "GoogleCloudApihubV1ActionExecutionDetail", + "description": "Required. The execution details for the action to execute." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ExecutionStatus": { + "description": "The execution status for the plugin instance.", + "id": "GoogleCloudApihubV1ExecutionStatus", + "properties": { + "currentExecutionState": { + "description": "Output only. The current state of the execution.", + "enum": [ + "CURRENT_EXECUTION_STATE_UNSPECIFIED", + "RUNNING", + "NOT_RUNNING" + ], + "enumDescriptions": [ + "Default unspecified execution state.", + "The plugin instance is executing.", + "The plugin instance is not running an execution." + ], + "readOnly": true, + "type": "string" + }, + "lastExecution": { + "$ref": "GoogleCloudApihubV1LastExecution", + "description": "Output only. The last execution of the plugin instance.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ExternalApi": { + "description": "An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.", + "id": "GoogleCloudApihubV1ExternalApi", + "properties": { + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudApihubV1AttributeValues" + }, + "description": "Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.", + "type": "object" + }, + "createTime": { + "description": "Output only. Creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).", + "type": "string" + }, + "displayName": { + "description": "Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).", + "type": "string" + }, + "documentation": { + "$ref": "GoogleCloudApihubV1Documentation", + "description": "Optional. Documentation of the external API." + }, + "endpoints": { + "description": "Optional. List of endpoints on which this API is accessible.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.", + "type": "string" + }, + "paths": { + "description": "Optional. List of paths served by this API.", + "items": { + "type": "string" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. Last update timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1GoogleServiceAccountConfig": { + "description": "Config for Google service account authentication.", + "id": "GoogleCloudApihubV1GoogleServiceAccountConfig", + "properties": { + "serviceAccount": { + "description": "Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1HostProjectRegistration": { + "description": "Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub.", + "id": "GoogleCloudApihubV1HostProjectRegistration", + "properties": { + "createTime": { + "description": "Output only. The time at which the host project registration was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "gcpProject": { + "description": "Required. Immutable. Google cloud project name in the format: \"projects/abc\" or \"projects/123\". As input, project name with either project id or number are accepted. As output, this field will contain project number.", + "type": "string" + }, + "name": { + "description": "Identifier. The name of the host project registration. Format: \"projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1HostingService": { + "description": "The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality.", + "id": "GoogleCloudApihubV1HostingService", + "properties": { + "serviceUri": { + "description": "Optional. The URI of the service implemented by the plugin developer, used to invoke the plugin's functionality. This information is only required for user defined plugins.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1HttpOperation": { + "description": "The HTTP Operation.", + "id": "GoogleCloudApihubV1HttpOperation", + "properties": { + "method": { + "description": "Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.", + "enum": [ + "METHOD_UNSPECIFIED", + "GET", + "PUT", + "POST", + "DELETE", + "OPTIONS", + "HEAD", + "PATCH", + "TRACE" + ], + "enumDescriptions": [ + "Method unspecified.", + "Get Operation type.", + "Put Operation type.", + "Post Operation type.", + "Delete Operation type.", + "Options Operation type.", + "Head Operation type.", + "Patch Operation type.", + "Trace Operation type." + ], + "type": "string" + }, + "path": { + "$ref": "GoogleCloudApihubV1Path", + "description": "Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Issue": { + "description": "Issue contains the details of a single issue found by the linter.", + "id": "GoogleCloudApihubV1Issue", + "properties": { + "code": { + "description": "Required. Rule code unique to each rule defined in linter.", + "type": "string" + }, + "message": { + "description": "Required. Human-readable message describing the issue found by the linter.", + "type": "string" + }, + "path": { + "description": "Required. An array of strings indicating the location in the analyzed document where the rule was triggered.", + "items": { + "type": "string" + }, + "type": "array" + }, + "range": { + "$ref": "GoogleCloudApihubV1Range", + "description": "Required. Object describing where in the file the issue was found." + }, + "severity": { + "description": "Required. Severity level of the rule violation.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "SEVERITY_ERROR", + "SEVERITY_WARNING", + "SEVERITY_INFO", + "SEVERITY_HINT" + ], + "enumDescriptions": [ + "Severity unspecified.", + "Severity error.", + "Severity warning.", + "Severity info.", + "Severity hint." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1LastExecution": { + "description": "The result of the last execution of the plugin instance.", + "id": "GoogleCloudApihubV1LastExecution", + "properties": { + "endTime": { + "description": "Output only. The last execution end time of the plugin instance.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "errorMessage": { + "description": "Output only. Error message describing the failure, if any, during the last execution.", + "readOnly": true, + "type": "string" + }, + "result": { + "description": "Output only. The result of the last execution of the plugin instance.", + "enum": [ + "RESULT_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Default unspecified execution result.", + "The plugin instance executed successfully.", + "The plugin instance execution failed." + ], + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. The last execution start time of the plugin instance.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1LintResponse": { + "description": "LintResponse contains the response from the linter.", + "id": "GoogleCloudApihubV1LintResponse", + "properties": { + "createTime": { + "description": "Required. Timestamp when the linting response was generated.", + "format": "google-datetime", + "type": "string" + }, + "issues": { + "description": "Optional. Array of issues found in the analyzed document.", + "items": { + "$ref": "GoogleCloudApihubV1Issue" + }, + "type": "array" + }, + "linter": { + "description": "Required. Name of the linter used.", + "enum": [ + "LINTER_UNSPECIFIED", + "SPECTRAL", + "OTHER" + ], + "enumDescriptions": [ + "Linter type unspecified.", + "Linter type spectral.", + "Linter type other." + ], + "type": "string" + }, + "source": { + "description": "Required. Name of the linting application.", + "type": "string" + }, + "state": { + "description": "Required. Lint state represents success or failure for linting.", + "enum": [ + "LINT_STATE_UNSPECIFIED", + "LINT_STATE_SUCCESS", + "LINT_STATE_ERROR" + ], + "enumDescriptions": [ + "Lint state unspecified.", + "Linting was completed successfully.", + "Linting encountered errors." + ], + "type": "string" + }, + "summary": { + "description": "Optional. Summary of all issue types and counts for each severity level.", + "items": { + "$ref": "GoogleCloudApihubV1SummaryEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1LintSpecRequest": { + "description": "The LintSpec method's request.", + "id": "GoogleCloudApihubV1LintSpecRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudApihubV1ListApiOperationsResponse": { + "description": "The ListApiOperations method's response.", + "id": "GoogleCloudApihubV1ListApiOperationsResponse", + "properties": { + "apiOperations": { + "description": "The operations corresponding to an API version.", + "items": { + "$ref": "GoogleCloudApihubV1ApiOperation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListApisResponse": { + "description": "The ListApis method's response.", + "id": "GoogleCloudApihubV1ListApisResponse", + "properties": { + "apis": { + "description": "The API resources present in the API hub.", + "items": { + "$ref": "GoogleCloudApihubV1Api" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListAttributesResponse": { + "description": "The ListAttributes method's response.", + "id": "GoogleCloudApihubV1ListAttributesResponse", + "properties": { + "attributes": { + "description": "The list of all attributes.", + "items": { + "$ref": "GoogleCloudApihubV1Attribute" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListCurationsResponse": { + "description": "The ListCurations method's response.", + "id": "GoogleCloudApihubV1ListCurationsResponse", + "properties": { + "curations": { + "description": "The curation resources present in the API hub.", + "items": { + "$ref": "GoogleCloudApihubV1Curation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListDependenciesResponse": { + "description": "The ListDependencies method's response.", + "id": "GoogleCloudApihubV1ListDependenciesResponse", + "properties": { + "dependencies": { + "description": "The dependency resources present in the API hub.", + "items": { + "$ref": "GoogleCloudApihubV1Dependency" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListDeploymentsResponse": { + "description": "The ListDeployments method's response.", + "id": "GoogleCloudApihubV1ListDeploymentsResponse", + "properties": { + "deployments": { + "description": "The deployment resources present in the API hub.", + "items": { + "$ref": "GoogleCloudApihubV1Deployment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListExternalApisResponse": { + "description": "The ListExternalApis method's response.", + "id": "GoogleCloudApihubV1ListExternalApisResponse", + "properties": { + "externalApis": { + "description": "The External API resources present in the API hub.", + "items": { + "$ref": "GoogleCloudApihubV1ExternalApi" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListHostProjectRegistrationsResponse": { + "description": "The ListHostProjectRegistrations method's response.", + "id": "GoogleCloudApihubV1ListHostProjectRegistrationsResponse", + "properties": { + "hostProjectRegistrations": { + "description": "The list of host project registrations.", + "items": { + "$ref": "GoogleCloudApihubV1HostProjectRegistration" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListPluginInstancesResponse": { + "description": "The ListPluginInstances method's response.", + "id": "GoogleCloudApihubV1ListPluginInstancesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "pluginInstances": { + "description": "The plugin instances from the specified parent resource.", + "items": { + "$ref": "GoogleCloudApihubV1PluginInstance" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListPluginsResponse": { + "description": "The ListPlugins method's response.", + "id": "GoogleCloudApihubV1ListPluginsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "plugins": { + "description": "The plugins from the specified parent resource.", + "items": { + "$ref": "GoogleCloudApihubV1Plugin" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse": { + "description": "The ListRuntimeProjectAttachments method's response.", + "id": "GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "runtimeProjectAttachments": { + "description": "List of runtime project attachments.", + "items": { + "$ref": "GoogleCloudApihubV1RuntimeProjectAttachment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListSpecsResponse": { + "description": "The ListSpecs method's response.", + "id": "GoogleCloudApihubV1ListSpecsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "specs": { + "description": "The specs corresponding to an API Version.", + "items": { + "$ref": "GoogleCloudApihubV1Spec" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1ListVersionsResponse": { + "description": "The ListVersions method's response.", + "id": "GoogleCloudApihubV1ListVersionsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "versions": { + "description": "The versions corresponding to an API.", + "items": { + "$ref": "GoogleCloudApihubV1Version" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1LookupApiHubInstanceResponse": { + "description": "The LookupApiHubInstance method's response.`", + "id": "GoogleCloudApihubV1LookupApiHubInstanceResponse", + "properties": { + "apiHubInstance": { + "$ref": "GoogleCloudApihubV1ApiHubInstance", + "description": "API Hub instance for a project if it exists, empty otherwise." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse": { + "description": "The ListRuntimeProjectAttachments method's response.", + "id": "GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse", + "properties": { + "runtimeProjectAttachment": { + "$ref": "GoogleCloudApihubV1RuntimeProjectAttachment", + "description": "Runtime project attachment for a project if exists, empty otherwise." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1MultiIntValues": { + "description": "The config variable value of data type multi int.", + "id": "GoogleCloudApihubV1MultiIntValues", + "properties": { + "values": { + "description": "Optional. The config variable value of data type multi int.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1MultiSelectValues": { + "description": "The config variable value of data type multi select.", + "id": "GoogleCloudApihubV1MultiSelectValues", + "properties": { + "values": { + "description": "Optional. The config variable value of data type multi select.", + "items": { + "$ref": "GoogleCloudApihubV1ConfigValueOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1MultiStringValues": { + "description": "The config variable value of data type multi string.", + "id": "GoogleCloudApihubV1MultiStringValues", + "properties": { + "values": { + "description": "Optional. The config variable value of data type multi string.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Oauth2ClientCredentialsConfig": { + "description": "Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.", + "id": "GoogleCloudApihubV1Oauth2ClientCredentialsConfig", + "properties": { + "clientId": { + "description": "Required. The client identifier.", + "type": "string" + }, + "clientSecret": { + "$ref": "GoogleCloudApihubV1Secret", + "description": "Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1OpenApiSpecDetails": { + "description": "OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails.", + "id": "GoogleCloudApihubV1OpenApiSpecDetails", + "properties": { + "format": { + "description": "Output only. The format of the spec.", + "enum": [ + "FORMAT_UNSPECIFIED", + "OPEN_API_SPEC_2_0", + "OPEN_API_SPEC_3_0", + "OPEN_API_SPEC_3_1" + ], + "enumDescriptions": [ + "SpecFile type unspecified.", + "OpenAPI Spec v2.0.", + "OpenAPI Spec v3.0.", + "OpenAPI Spec v3.1." + ], + "readOnly": true, + "type": "string" + }, + "owner": { + "$ref": "GoogleCloudApihubV1Owner", + "description": "Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.", + "readOnly": true + }, + "version": { + "description": "Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1OperationDetails": { + "description": "The operation details parsed from the spec.", + "id": "GoogleCloudApihubV1OperationDetails", + "properties": { + "deprecated": { + "description": "Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.", + "type": "boolean" + }, + "description": { + "description": "Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used.", + "type": "string" + }, + "documentation": { + "$ref": "GoogleCloudApihubV1Documentation", + "description": "Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec." + }, + "httpOperation": { + "$ref": "GoogleCloudApihubV1HttpOperation", + "description": "The HTTP Operation." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudApihubV1OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Owner": { + "description": "Owner details.", + "id": "GoogleCloudApihubV1Owner", + "properties": { + "displayName": { + "description": "Optional. The name of the owner.", + "type": "string" + }, + "email": { + "description": "Required. The email of the owner.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Path": { + "description": "The path details derived from the spec.", + "id": "GoogleCloudApihubV1Path", + "properties": { + "description": { + "description": "Optional. A short description for the path applicable to all operations.", + "type": "string" + }, + "path": { + "description": "Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Plugin": { + "description": "A plugin resource in the API Hub.", + "id": "GoogleCloudApihubV1Plugin", + "properties": { + "actionsConfig": { + "description": "Optional. The configuration of actions supported by the plugin.", + "items": { + "$ref": "GoogleCloudApihubV1PluginActionConfig" + }, + "type": "array" + }, + "configTemplate": { + "$ref": "GoogleCloudApihubV1ConfigTemplate", + "description": "Optional. The configuration template for the plugin." + }, + "createTime": { + "description": "Output only. Timestamp indicating when the plugin was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The plugin description. Max length is 2000 characters (Unicode code points).", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the plugin. Max length is 50 characters (Unicode code points).", + "type": "string" + }, + "documentation": { + "$ref": "GoogleCloudApihubV1Documentation", + "description": "Optional. The documentation of the plugin, that explains how to set up and use the plugin." + }, + "hostingService": { + "$ref": "GoogleCloudApihubV1HostingService", + "description": "Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI." + }, + "name": { + "description": "Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}`", + "type": "string" + }, + "ownershipType": { + "description": "Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.", + "enum": [ + "OWNERSHIP_TYPE_UNSPECIFIED", + "SYSTEM_OWNED", + "USER_OWNED" + ], + "enumDescriptions": [ + "Default unspecified type.", + "System owned plugins are defined by API hub and are available out of the box in API hub.", + "User owned plugins are defined by the user and need to be explicitly added to API hub via CreatePlugin method." + ], + "readOnly": true, + "type": "string" + }, + "pluginCategory": { + "description": "Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.", + "enum": [ + "PLUGIN_CATEGORY_UNSPECIFIED", + "API_GATEWAY", + "API_PRODUCER" + ], + "enumDescriptions": [ + "Default unspecified plugin type.", + "API_GATEWAY plugins represent plugins built for API Gateways like Apigee.", + "API_PRODUCER plugins represent plugins built for API Producers like Cloud Run, Application Integration etc." + ], + "type": "string" + }, + "state": { + "description": "Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The plugin is enabled.", + "The plugin is disabled." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The type of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-plugin-type` attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. Note this field is not required for plugins developed via plugin framework." + }, + "updateTime": { + "description": "Output only. Timestamp indicating when the plugin was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1PluginActionConfig": { + "description": "PluginActionConfig represents the configuration of an action supported by a plugin.", + "id": "GoogleCloudApihubV1PluginActionConfig", + "properties": { + "description": { + "description": "Required. The description of the operation performed by the action.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the action.", + "type": "string" + }, + "id": { + "description": "Required. The id of the action.", + "type": "string" + }, + "triggerMode": { + "description": "Required. The trigger mode supported by the action.", + "enum": [ + "TRIGGER_MODE_UNSPECIFIED", + "API_HUB_ON_DEMAND_TRIGGER", + "API_HUB_SCHEDULE_TRIGGER", + "NON_API_HUB_MANAGED" + ], + "enumDescriptions": [ + "Default unspecified mode.", + "This action can be executed by invoking ExecutePluginInstanceAction API with the given action id. To support this, the plugin hosting service should handle this action id as part of execute call.", + "This action will be executed on schedule by invoking ExecutePluginInstanceAction API with the given action id. To set the schedule, the user can provide the cron expression in the PluginAction field for a given plugin instance. To support this, the plugin hosting service should handle this action id as part of execute call. Note, on demand execution will be supported by default in this trigger mode.", + "The execution of this plugin is not handled by API hub. In this case, the plugin hosting service need not handle this action id as part of the execute call." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1PluginInstance": { + "description": "Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.", + "id": "GoogleCloudApihubV1PluginInstance", + "properties": { + "actions": { + "description": "Required. The action status for the plugin instance.", + "items": { + "$ref": "GoogleCloudApihubV1PluginInstanceAction" + }, + "type": "array" + }, + "additionalConfig": { + "additionalProperties": { + "$ref": "GoogleCloudApihubV1ConfigVariable" + }, + "description": "Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.", + "type": "object" + }, + "authConfig": { + "$ref": "GoogleCloudApihubV1AuthConfig", + "description": "Optional. The authentication information for this plugin instance." + }, + "createTime": { + "description": "Output only. Timestamp indicating when the plugin instance was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name for this plugin instance. Max length is 255 characters.", + "type": "string" + }, + "errorMessage": { + "description": "Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "APPLYING_CONFIG", + "ERROR", + "FAILED", + "DELETING" + ], + "enumDescriptions": [ + "Default unspecified state.", + "The plugin instance is being created.", + "The plugin instance is active and ready for executions. This is the only state where executions can run on the plugin instance.", + "The updated config that contains additional_config and auth_config is being applied.", + "The ERROR state can come while applying config. Users can retrigger ApplyPluginInstanceConfig to restore the plugin instance back to active state. Note, In case the ERROR state happens while applying config (auth_config, additional_config), the plugin instance will reflect the config which was trying to be applied while error happened. In order to overwrite, trigger ApplyConfig with a new config.", + "The plugin instance is in a failed state. This indicates that an unrecoverable error occurred during a previous operation (Create, Delete).", + "The plugin instance is being deleted. Delete is only possible if there is no other operation running on the plugin instance and plugin instance action." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp indicating when the plugin instance was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1PluginInstanceAction": { + "description": "PluginInstanceAction represents an action which can be executed in the plugin instance.", + "id": "GoogleCloudApihubV1PluginInstanceAction", + "properties": { + "actionId": { + "description": "Required. This should map to one of the action id specified in actions_config in the plugin.", + "type": "string" + }, + "curationConfig": { + "$ref": "GoogleCloudApihubV1CurationConfig", + "description": "Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer." + }, + "hubInstanceAction": { + "$ref": "GoogleCloudApihubV1ExecutionStatus", + "description": "Optional. The execution information for the plugin instance action done corresponding to an API hub instance." + }, + "scheduleCronExpression": { + "description": "Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.", + "type": "string" + }, + "scheduleTimeZone": { + "description": "Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the plugin action in the plugin instance.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "ENABLING", + "DISABLING", + "ERROR" + ], + "enumDescriptions": [ + "Default unspecified state.", + "The action is enabled in the plugin instance i.e., executions can be triggered for this action.", + "The action is disabled in the plugin instance i.e., no executions can be triggered for this action. This state indicates that the user explicitly disabled the instance, and no further action is needed unless the user wants to re-enable it.", + "The action in the plugin instance is being enabled.", + "The action in the plugin instance is being disabled.", + "The ERROR state can come while enabling/disabling plugin instance action. Users can retrigger enable, disable via EnablePluginInstanceAction and DisablePluginInstanceAction to restore the action back to enabled/disabled state. Note enable/disable on actions can only be triggered if plugin instance is in Active state." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1PluginInstanceActionID": { + "description": "The plugin instance and associated action that is using the curation.", + "id": "GoogleCloudApihubV1PluginInstanceActionID", + "properties": { + "actionId": { + "description": "Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.", + "readOnly": true, + "type": "string" + }, + "pluginInstance": { + "description": "Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1PluginInstanceActionSource": { + "description": "PluginInstanceActionSource represents the plugin instance action source.", + "id": "GoogleCloudApihubV1PluginInstanceActionSource", + "properties": { + "actionId": { + "description": "Output only. The id of the plugin instance action.", + "readOnly": true, + "type": "string" + }, + "pluginInstance": { + "description": "Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Point": { + "description": "Point within the file (line and character).", + "id": "GoogleCloudApihubV1Point", + "properties": { + "character": { + "description": "Required. Character position within the line (zero-indexed).", + "format": "int32", + "type": "integer" + }, + "line": { + "description": "Required. Line number (zero-indexed).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Range": { + "description": "Object describing where in the file the issue was found.", + "id": "GoogleCloudApihubV1Range", + "properties": { + "end": { + "$ref": "GoogleCloudApihubV1Point", + "description": "Required. End of the issue." + }, + "start": { + "$ref": "GoogleCloudApihubV1Point", + "description": "Required. Start of the issue." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1RuntimeProjectAttachment": { + "description": "Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.", + "id": "GoogleCloudApihubV1RuntimeProjectAttachment", + "properties": { + "createTime": { + "description": "Output only. Create time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of a runtime project attachment. Format: \"projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}\".", + "type": "string" + }, + "runtimeProject": { + "description": "Required. Immutable. Google cloud project name in the format: \"projects/abc\" or \"projects/123\". As input, project name with either project id or number are accepted. As output, this field will contain project number.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Schema": { + "description": "The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the `definitions` section for OpenAPI 2.0 version and in `components.schemas` section for OpenAPI 3.0 and 3.1 version.", + "id": "GoogleCloudApihubV1Schema", + "properties": { + "displayName": { + "description": "Output only. The display name of the schema. This will map to the name of the schema in the spec.", + "readOnly": true, + "type": "string" + }, + "rawValue": { + "description": "Output only. The raw value of the schema definition corresponding to the schema name in the spec.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1SearchResourcesRequest": { + "description": "The SearchResources method's request.", + "id": "GoogleCloudApihubV1SearchResourcesRequest", + "properties": { + "filter": { + "description": "Optional. An expression that filters the list of search results. 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 `=`. Filters are not case sensitive. The following field names are eligible for filtering: * `resource_type` - The type of resource in the search results. Must be one of the following: `Api`, `ApiOperation`, `Deployment`, `Definition`, `Spec` or `Version`. This field can only be specified once in the filter. Here are is an example: * `resource_type = Api` - The resource_type is _Api_.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of search results to return. The service may return fewer than this value. If unspecified at most 10 search results will be returned. If value is negative then `INVALID_ARGUMENT` error is returned. The maximum value is 25; values above 25 will be coerced to 25. While paginating, you can specify a new page size parameter for each page of search results to be listed.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous SearchResources call. Specify this parameter to retrieve the next page of transactions. When paginating, you must specify the `page_token` parameter and all the other parameters except page_size should be specified with the same value which was used in the previous call. If the other fields are set with a different value than the previous call then `INVALID_ARGUMENT` error is returned.", + "type": "string" + }, + "query": { + "description": "Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1SearchResourcesResponse": { + "description": "Response for the SearchResources method.", + "id": "GoogleCloudApihubV1SearchResourcesResponse", + "properties": { + "nextPageToken": { + "description": "Pass this token in the SearchResourcesRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response.", + "type": "string" + }, + "searchResults": { + "description": "List of search results according to the filter and search query specified. The order of search results represents the ranking.", + "items": { + "$ref": "GoogleCloudApihubV1SearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1SearchResult": { + "description": "Represents the search results.", + "id": "GoogleCloudApihubV1SearchResult", + "properties": { + "resource": { + "$ref": "GoogleCloudApihubV1ApiHubResource", + "description": "This represents the ApiHubResource. Note: Only selected fields of the resources are populated in response." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Secret": { + "description": "Secret provides a reference to entries in Secret Manager.", + "id": "GoogleCloudApihubV1Secret", + "properties": { + "secretVersion": { + "description": "Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1SourceMetadata": { + "description": "SourceMetadata represents the metadata for a resource at the source.", + "id": "GoogleCloudApihubV1SourceMetadata", + "properties": { + "originalResourceCreateTime": { + "description": "Output only. The time at which the resource was created at the source.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "originalResourceId": { + "description": "Output only. The unique identifier of the resource at the source.", + "readOnly": true, + "type": "string" + }, + "originalResourceUpdateTime": { + "description": "Output only. The time at which the resource was last updated at the source.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "pluginInstanceActionSource": { + "$ref": "GoogleCloudApihubV1PluginInstanceActionSource", + "description": "Output only. The source of the resource is a plugin instance action.", + "readOnly": true + }, + "sourceType": { + "description": "Output only. The type of the source.", + "enum": [ + "SOURCE_TYPE_UNSPECIFIED", + "PLUGIN" + ], + "enumDescriptions": [ + "Source type not specified.", + "Source type plugin." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Spec": { + "description": "Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.", + "id": "GoogleCloudApihubV1Spec", + "properties": { + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudApihubV1AttributeValues" + }, + "description": "Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.", + "type": "object" + }, + "contents": { + "$ref": "GoogleCloudApihubV1SpecContents", + "description": "Optional. Input only. The contents of the uploaded spec." + }, + "createTime": { + "description": "Output only. The time at which the spec was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "details": { + "$ref": "GoogleCloudApihubV1SpecDetails", + "description": "Output only. Details parsed from the spec.", + "readOnly": true + }, + "displayName": { + "description": "Required. The display name of the spec. This can contain the file name of the spec.", + "type": "string" + }, + "documentation": { + "$ref": "GoogleCloudApihubV1Documentation", + "description": "Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec." + }, + "lintResponse": { + "$ref": "GoogleCloudApihubV1LintResponse", + "description": "Optional. The lint response for the spec." + }, + "name": { + "description": "Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`", + "type": "string" + }, + "parsingMode": { + "description": "Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.", + "enum": [ + "PARSING_MODE_UNSPECIFIED", + "RELAXED", + "STRICT" + ], + "enumDescriptions": [ + "Defaults to `RELAXED`.", + "Parsing of the Spec on create and update is relaxed, meaning that parsing errors the spec contents will not fail the API call.", + "Parsing of the Spec on create and update is strict, meaning that parsing errors in the spec contents will fail the API call." + ], + "type": "string" + }, + "sourceMetadata": { + "description": "Output only. The list of sources and metadata from the sources of the spec.", + "items": { + "$ref": "GoogleCloudApihubV1SourceMetadata" + }, + "readOnly": true, + "type": "array" + }, + "sourceUri": { + "description": "Optional. The URI of the spec source in case file is uploaded from an external version control system.", + "type": "string" + }, + "specType": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided." + }, + "updateTime": { + "description": "Output only. The time at which the spec was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1SpecContents": { + "description": "The spec contents.", + "id": "GoogleCloudApihubV1SpecContents", + "properties": { + "contents": { + "description": "Required. The contents of the spec.", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1SpecDetails": { + "description": "SpecDetails contains the details parsed from supported spec types.", + "id": "GoogleCloudApihubV1SpecDetails", + "properties": { + "description": { + "description": "Output only. The description of the spec.", + "readOnly": true, + "type": "string" + }, + "openApiSpecDetails": { + "$ref": "GoogleCloudApihubV1OpenApiSpecDetails", + "description": "Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudApihubV1SpecMetadata": { + "description": "The metadata associated with a spec of the API version.", + "id": "GoogleCloudApihubV1SpecMetadata", + "properties": { + "originalCreateTime": { + "description": "Optional. Timestamp indicating when the spec was created at the source.", + "format": "google-datetime", + "type": "string" + }, + "originalId": { + "description": "Optional. The unique identifier of the spec in the system where it was originally created.", + "type": "string" + }, + "originalUpdateTime": { + "description": "Required. Timestamp indicating when the spec was last updated at the source.", + "format": "google-datetime", + "type": "string" + }, + "spec": { + "$ref": "GoogleCloudApihubV1Spec", + "description": "Required. The spec resource to be pushed to Hub's collect layer. The ID of the spec will be generated by Hub." + } + }, + "type": "object" + }, + "GoogleCloudApihubV1StringAttributeValues": { + "description": "The attribute values of data type string or JSON.", + "id": "GoogleCloudApihubV1StringAttributeValues", + "properties": { + "values": { + "description": "Required. The attribute values in case attribute data type is string or JSON.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1StyleGuide": { + "description": "Represents a singleton style guide resource to be used for linting Open API specs.", + "id": "GoogleCloudApihubV1StyleGuide", + "properties": { + "contents": { + "$ref": "GoogleCloudApihubV1StyleGuideContents", + "description": "Required. Input only. The contents of the uploaded style guide." + }, + "linter": { + "description": "Required. Target linter for the style guide.", + "enum": [ + "LINTER_UNSPECIFIED", + "SPECTRAL", + "OTHER" + ], + "enumDescriptions": [ + "Linter type unspecified.", + "Linter type spectral.", + "Linter type other." + ], + "type": "string" + }, + "name": { + "description": "Identifier. The name of the style guide. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1StyleGuideContents": { + "description": "The style guide contents.", + "id": "GoogleCloudApihubV1StyleGuideContents", + "properties": { + "contents": { + "description": "Required. The contents of the style guide.", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "Required. The mime type of the content.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1SummaryEntry": { + "description": "Count of issues with a given severity.", + "id": "GoogleCloudApihubV1SummaryEntry", + "properties": { + "count": { + "description": "Required. Count of issues with the given severity.", + "format": "int32", + "type": "integer" + }, + "severity": { + "description": "Required. Severity of the issue.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "SEVERITY_ERROR", + "SEVERITY_WARNING", + "SEVERITY_INFO", + "SEVERITY_HINT" + ], + "enumDescriptions": [ + "Severity unspecified.", + "Severity error.", + "Severity warning.", + "Severity info.", + "Severity hint." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1UserPasswordConfig": { + "description": "Parameters to support Username and Password Authentication.", + "id": "GoogleCloudApihubV1UserPasswordConfig", + "properties": { + "password": { + "$ref": "GoogleCloudApihubV1Secret", + "description": "Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret." + }, + "username": { + "description": "Required. Username.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1Version": { + "description": "Represents a version of the API resource in API hub. This is also referred to as the API version.", + "id": "GoogleCloudApihubV1Version", + "properties": { + "accreditation": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "apiOperations": { + "description": "Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudApihubV1AttributeValues" + }, + "description": "Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.", + "type": "object" + }, + "compliance": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "createTime": { + "description": "Output only. The time at which the version was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "definitions": { + "description": "Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "deployments": { + "description": "Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Optional. The description of the version.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the version.", + "type": "string" + }, + "documentation": { + "$ref": "GoogleCloudApihubV1Documentation", + "description": "Optional. The documentation of the version." + }, + "lifecycle": { + "$ref": "GoogleCloudApihubV1AttributeValues", + "description": "Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute." + }, + "name": { + "description": "Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", + "type": "string" + }, + "selectedDeployment": { + "description": "Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`", + "type": "string" + }, + "sourceMetadata": { + "description": "Output only. The list of sources and metadata from the sources of the version.", + "items": { + "$ref": "GoogleCloudApihubV1SourceMetadata" + }, + "readOnly": true, + "type": "array" + }, + "specs": { + "description": "Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "updateTime": { + "description": "Output only. The time at which the version was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApihubV1VersionMetadata": { + "description": "The metadata associated with a version of the API resource.", + "id": "GoogleCloudApihubV1VersionMetadata", + "properties": { + "deployments": { + "description": "Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc.)", + "items": { + "$ref": "GoogleCloudApihubV1DeploymentMetadata" + }, + "type": "array" + }, + "originalCreateTime": { + "description": "Optional. Timestamp indicating when the version was created at the source.", + "format": "google-datetime", + "type": "string" + }, + "originalId": { + "description": "Optional. The unique identifier of the version in the system where it was originally created.", + "type": "string" + }, + "originalUpdateTime": { + "description": "Required. Timestamp indicating when the version was last updated at the source.", + "format": "google-datetime", + "type": "string" + }, + "specs": { + "description": "Optional. The specs associated with this version. Note that an API version can be associated with multiple specs.", + "items": { + "$ref": "GoogleCloudApihubV1SpecMetadata" + }, + "type": "array" + }, + "version": { + "$ref": "GoogleCloudApihubV1Version", + "description": "Required. Represents a version of the API resource in API hub. The ID of the version will be generated by Hub." + } + }, + "type": "object" + }, + "GoogleCloudCommonOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudCommonOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "cancelRequested": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "statusDetail": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudLocationListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "GoogleCloudLocationListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudLocationLocation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudLocationLocation": { + "description": "A resource that represents a Google Cloud location.", + "id": "GoogleCloudLocationLocation", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleLongrunningCancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "GoogleLongrunningCancelOperationRequest", + "properties": {}, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleRpcStatus": { + "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": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "API hub API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/appengine-v1.json b/discovery/appengine-v1.json index ef5b99407a..56e8aec387 100644 --- a/discovery/appengine-v1.json +++ b/discovery/appengine-v1.json @@ -1766,6 +1766,57 @@ } } }, + "domainMappings": { + "methods": { + "get": { + "description": "Gets the specified domain mapping.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", + "httpMethod": "GET", + "id": "appengine.projects.locations.applications.domainMappings.get", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId", + "domainMappingsId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "domainMappingsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "projectsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", + "response": { + "$ref": "DomainMapping" + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, "services": { "methods": { "delete": { @@ -1812,6 +1863,65 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the configuration of the specified service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}", + "httpMethod": "PATCH", + "id": "appengine.projects.locations.applications.services.patch", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId", + "servicesId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "migrateTraffic": { + "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).", + "location": "query", + "type": "boolean" + }, + "projectsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.", + "location": "path", + "required": true, + "type": "string" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}", + "request": { + "$ref": "Service" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1941,7 +2051,7 @@ } } }, - "revision": "20250409", + "revision": "20250512", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/discovery/appengine-v1alpha.json b/discovery/appengine-v1alpha.json index 388bd77a90..d7dd5fce60 100644 --- a/discovery/appengine-v1alpha.json +++ b/discovery/appengine-v1alpha.json @@ -857,6 +857,57 @@ ] } } + }, + "domainMappings": { + "methods": { + "get": { + "description": "Gets the specified domain mapping.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", + "httpMethod": "GET", + "id": "appengine.projects.locations.applications.domainMappings.get", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId", + "domainMappingsId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "domainMappingsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "projectsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", + "response": { + "$ref": "DomainMapping" + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } } } }, @@ -958,7 +1009,7 @@ } } }, - "revision": "20250409", + "revision": "20250512", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { diff --git a/discovery/appengine-v1beta.json b/discovery/appengine-v1beta.json index 6e2e47bd39..f72a609f9d 100644 --- a/discovery/appengine-v1beta.json +++ b/discovery/appengine-v1beta.json @@ -1879,6 +1879,57 @@ } } }, + "domainMappings": { + "methods": { + "get": { + "description": "Gets the specified domain mapping.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", + "httpMethod": "GET", + "id": "appengine.projects.locations.applications.domainMappings.get", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId", + "domainMappingsId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "domainMappingsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "projectsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}", + "response": { + "$ref": "DomainMapping" + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, "services": { "methods": { "delete": { @@ -1925,6 +1976,65 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the configuration of the specified service.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}", + "httpMethod": "PATCH", + "id": "appengine.projects.locations.applications.services.patch", + "parameterOrder": [ + "projectsId", + "locationsId", + "applicationsId", + "servicesId" + ], + "parameters": { + "applicationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "migrateTraffic": { + "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).", + "location": "query", + "type": "boolean" + }, + "projectsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.", + "location": "path", + "required": true, + "type": "string" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `projectsId`.", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}", + "request": { + "$ref": "Service" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -2147,7 +2257,7 @@ } } }, - "revision": "20250409", + "revision": "20250512", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/discovery/artifactregistry-v1.json b/discovery/artifactregistry-v1.json index 435e31cb92..81996f2b79 100644 --- a/discovery/artifactregistry-v1.json +++ b/discovery/artifactregistry-v1.json @@ -89,6 +89,11 @@ "endpointUrl": "https://artifactregistry.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-southwest1.rep.googleapis.com/", @@ -159,6 +164,11 @@ "endpointUrl": "https://artifactregistry.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.southamerica-east1.rep.googleapis.com/", @@ -2455,7 +2465,7 @@ } } }, - "revision": "20250425", + "revision": "20250502", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/discovery/artifactregistry-v1beta1.json b/discovery/artifactregistry-v1beta1.json index e224afd159..e37da65489 100644 --- a/discovery/artifactregistry-v1beta1.json +++ b/discovery/artifactregistry-v1beta1.json @@ -89,6 +89,11 @@ "endpointUrl": "https://artifactregistry.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-southwest1.rep.googleapis.com/", @@ -159,6 +164,11 @@ "endpointUrl": "https://artifactregistry.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.southamerica-east1.rep.googleapis.com/", @@ -1172,7 +1182,7 @@ } } }, - "revision": "20250425", + "revision": "20250502", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/artifactregistry-v1beta2.json b/discovery/artifactregistry-v1beta2.json index baa76e2df3..092352e57b 100644 --- a/discovery/artifactregistry-v1beta2.json +++ b/discovery/artifactregistry-v1beta2.json @@ -89,6 +89,11 @@ "endpointUrl": "https://artifactregistry.europe-north1.rep.googleapis.com/", "location": "europe-north1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-southwest1.rep.googleapis.com/", @@ -159,6 +164,11 @@ "endpointUrl": "https://artifactregistry.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://artifactregistry.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.southamerica-east1.rep.googleapis.com/", @@ -1440,7 +1450,7 @@ } } }, - "revision": "20250425", + "revision": "20250502", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index cb320d64f1..0c5bf0fcf3 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -319,6 +319,45 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "patch": { + "description": "Update a BackupPlanAssociation", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}", + "httpMethod": "PATCH", + "id": "backupdr.projects.locations.backupPlanAssociations.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he 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": "Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlanAssociation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently backup_plan_association.backup_plan is the only supported field.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "BackupPlanAssociation" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "triggerBackup": { "description": "Triggers a new Backup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}:triggerBackup", @@ -753,6 +792,11 @@ "location": "query", "type": "boolean" }, + "forceUpdateAccessRestriction": { + "description": "Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Output only. Identifier. Name of the backup vault to create. It must have the format`\"projects/{project}/locations/{location}/backupVaults/{backupvault}\"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.", "location": "path", @@ -1751,7 +1795,7 @@ } } }, - "revision": "20250411", + "revision": "20250509", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2156,6 +2200,11 @@ "readOnly": true, "type": "string" }, + "diskBackupProperties": { + "$ref": "DiskBackupProperties", + "description": "Output only. Disk specific backup properties.", + "readOnly": true + }, "enforcedRetentionEndTime": { "description": "Optional. The backup can not be deleted before this time.", "format": "google-datetime", @@ -2648,6 +2697,14 @@ "readOnly": true, "type": "string" }, + "supportedResourceTypes": { + "description": "Output only. All resource types to which backupPlan can be applied.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "updateTime": { "description": "Output only. When the `BackupPlan` was last updated.", "format": "google-datetime", @@ -2835,14 +2892,16 @@ "CREATING", "ACTIVE", "DELETING", - "ERROR" + "ERROR", + "UPDATING" ], "enumDescriptions": [ "State not set.", "The backup vault is being created.", "The backup vault has been created and is fully usable.", "The backup vault is being deleted.", - "The backup vault is experiencing an issue and might be unusable." + "The backup vault is experiencing an issue and might be unusable.", + "The backup vault is being updated." ], "readOnly": true, "type": "string" @@ -3229,6 +3288,11 @@ "description": "Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.", "id": "DataSource", "properties": { + "backupBlockedByVaultAccessRestriction": { + "description": "Output only. This field is set to true if the backup is blocked by vault access restriction.", + "readOnly": true, + "type": "boolean" + }, "backupConfigInfo": { "$ref": "BackupConfigInfo", "description": "Output only. Details of how the resource is configured for backup.", @@ -3363,6 +3427,10 @@ "$ref": "ComputeInstanceDataSourceProperties", "description": "ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level." }, + "diskDatasourceProperties": { + "$ref": "DiskDataSourceProperties", + "description": "DiskDataSourceProperties has a subset of Disk properties that are useful at the Datasource level." + }, "gcpResourcename": { "description": "Output only. Full resource pathname URL of the source Google Cloud resource.", "readOnly": true, @@ -3379,6 +3447,226 @@ }, "type": "object" }, + "DiskBackupProperties": { + "description": "DiskBackupProperties represents the properties of a Disk backup.", + "id": "DiskBackupProperties", + "properties": { + "architecture": { + "description": "The architecture of the source disk. Valid values are ARM64 or X86_64.", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "X86_64", + "ARM64" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Disks with architecture X86_64", + "Disks with architecture ARM64" + ], + "type": "string" + }, + "description": { + "description": "A description of the source disk.", + "type": "string" + }, + "guestOsFeature": { + "description": "A list of guest OS features that are applicable to this backup.", + "items": { + "$ref": "GuestOsFeature" + }, + "type": "array" + }, + "licenses": { + "description": "A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image.", + "items": { + "type": "string" + }, + "type": "array" + }, + "region": { + "description": "Region and zone are mutually exclusive fields. The URL of the region of the source disk.", + "type": "string" + }, + "replicaZones": { + "description": "The URL of the Zones where the source disk should be replicated.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sizeGb": { + "description": "Size(in GB) of the source disk.", + "format": "int64", + "type": "string" + }, + "sourceDisk": { + "description": "The source disk used to create this backup.", + "type": "string" + }, + "type": { + "description": "The URL of the type of the disk.", + "type": "string" + }, + "zone": { + "description": "The URL of the Zone where the source disk.", + "type": "string" + } + }, + "type": "object" + }, + "DiskDataSourceProperties": { + "description": "DiskDataSourceProperties represents the properties of a Disk resource that are stored in the DataSource. .", + "id": "DiskDataSourceProperties", + "properties": { + "description": { + "description": "The description of the disk.", + "type": "string" + }, + "name": { + "description": "Name of the disk backed up by the datasource.", + "type": "string" + }, + "sizeGb": { + "description": "The size of the disk in GB.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "The type of the disk.", + "type": "string" + } + }, + "type": "object" + }, + "DiskRestoreProperties": { + "description": "DiskRestoreProperties represents the properties of a Disk restore.", + "id": "DiskRestoreProperties", + "properties": { + "accessMode": { + "description": "Optional. The access mode of the disk.", + "enum": [ + "READ_WRITE_SINGLE", + "READ_WRITE_MANY", + "READ_ONLY_MANY" + ], + "enumDescriptions": [ + "The default AccessMode, means the disk can be attached to single instance in RW mode.", + "The AccessMode means the disk can be attached to multiple instances in RW mode.", + "The AccessMode means the disk can be attached to multiple instances in RO mode." + ], + "type": "string" + }, + "architecture": { + "description": "Optional. The architecture of the source disk. Valid values are ARM64 or X86_64.", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "X86_64", + "ARM64" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Disks with architecture X86_64", + "Disks with architecture ARM64" + ], + "type": "string" + }, + "description": { + "description": "Optional. An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "diskEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Optional. Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key." + }, + "enableConfidentialCompute": { + "description": "Optional. Indicates whether this disk is using confidential compute mode. Encryption with a Cloud KMS key is required to enable this option.", + "type": "boolean" + }, + "guestOsFeature": { + "description": "Optional. A list of features to enable in the guest operating system. This is applicable only for bootable images.", + "items": { + "$ref": "GuestOsFeature" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels to apply to this disk. These can be modified later using setLabels method. Label values can be empty.", + "type": "object" + }, + "licenses": { + "description": "Optional. A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Required. Name of the disk..", + "type": "string" + }, + "physicalBlockSizeBytes": { + "description": "Optional. Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently, the supported size is 4096.", + "format": "int64", + "type": "string" + }, + "provisionedIops": { + "description": "Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle.", + "format": "int64", + "type": "string" + }, + "provisionedThroughput": { + "description": "Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle.", + "format": "int64", + "type": "string" + }, + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource manager tags to be bound to the disk.", + "type": "object" + }, + "resourcePolicy": { + "description": "Optional. Resource policies applied to this disk.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sizeGb": { + "description": "Required. The size of the disk in GB.", + "format": "int64", + "type": "string" + }, + "storagePool": { + "description": "Optional. The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource.", + "type": "string" + }, + "type": { + "description": "Required. URL of the disk type resource describing which disk type to use to create the disk.", + "type": "string" + } + }, + "type": "object" + }, + "DiskTargetEnvironment": { + "description": "DiskTargetEnvironment represents the target environment for the disk.", + "id": "DiskTargetEnvironment", + "properties": { + "project": { + "description": "Required. Target project for the disk.", + "type": "string" + }, + "zone": { + "description": "Required. Target zone for the disk.", + "type": "string" + } + }, + "type": "object" + }, "DisplayDevice": { "description": "A set of Display Device options", "id": "DisplayDevice", @@ -4424,6 +4712,28 @@ }, "type": "object" }, + "RegionDiskTargetEnvironment": { + "description": "RegionDiskTargetEnvironment represents the target environment for the disk.", + "id": "RegionDiskTargetEnvironment", + "properties": { + "project": { + "description": "Required. Target project for the disk.", + "type": "string" + }, + "region": { + "description": "Required. Target region for the disk.", + "type": "string" + }, + "replicaZones": { + "description": "Required. Target URLs of the replica zones for the disk.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "RemoveDataSourceRequest": { "description": "Message for deleting a DataSource.", "id": "RemoveDataSourceRequest", @@ -4512,6 +4822,18 @@ "$ref": "ComputeInstanceTargetEnvironment", "description": "Compute Engine target environment to be used during restore." }, + "diskRestoreProperties": { + "$ref": "DiskRestoreProperties", + "description": "Disk properties to be overridden during restore." + }, + "diskTargetEnvironment": { + "$ref": "DiskTargetEnvironment", + "description": "Disk target environment to be used during restore." + }, + "regionDiskTargetEnvironment": { + "$ref": "RegionDiskTargetEnvironment", + "description": "Region disk target environment to be used during restore." + }, "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" diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index 290e372c17..3083ca62c1 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -2290,7 +2290,7 @@ } } }, - "revision": "20250427", + "revision": "20250511", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -3763,6 +3763,11 @@ "$ref": "DatasetReference", "description": "The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID." }, + "externalDatasetReference": { + "$ref": "ExternalDatasetReference", + "description": "Output only. Reference to a read-only external dataset defined in data catalogs outside of BigQuery. Filled out when the dataset type is EXTERNAL.", + "readOnly": true + }, "friendlyName": { "description": "An alternate name for the dataset. The friendly name is purely decorative in nature.", "type": "string" @@ -5623,7 +5628,7 @@ "type": "boolean" }, "writeDisposition": { - "description": "Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", + "description": "Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", "type": "string" } }, @@ -5761,7 +5766,7 @@ "type": "array" }, "writeDisposition": { - "description": "Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", + "description": "Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.", "type": "string" }, "writeIncrementalResults": { diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index edcb806649..f4af6a3b73 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -315,7 +315,7 @@ ], "parameters": { "name": { - "description": "The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`.", + "description": "Identifier. The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/biReservation$", "required": true, @@ -689,6 +689,38 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Reservations To call this method, you must have the following Google IAM permissions: - `bigqueryreservation.reservations.getIamPolicy` to get policies on reservations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}:getIamPolicy", + "httpMethod": "GET", + "id": "bigqueryreservation.projects.locations.reservations.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all the reservations for the project in the specified location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations", @@ -760,6 +792,64 @@ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setIamPolicy": { + "description": "Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Reservations To call this method, you must have the following Google IAM permissions: - `bigqueryreservation.reservations.setIamPolicy` to set policies on reservations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}:setIamPolicy", + "httpMethod": "POST", + "id": "bigqueryreservation.projects.locations.reservations.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Reservations No Google IAM permissions are required to call this method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}:testIamPermissions", + "httpMethod": "POST", + "id": "bigqueryreservation.projects.locations.reservations.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/[^/]+/reservations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -935,7 +1025,7 @@ } } }, - "revision": "20250421", + "revision": "20250503", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -943,7 +1033,7 @@ "id": "Assignment", "properties": { "assignee": { - "description": "The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.", + "description": "Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`.", "type": "string" }, "enableGeminiInBigquery": { @@ -951,7 +1041,7 @@ "type": "boolean" }, "jobType": { - "description": "Which type of jobs will use the reservation.", + "description": "Optional. Which type of jobs will use the reservation.", "enum": [ "JOB_TYPE_UNSPECIFIED", "PIPELINE", @@ -993,6 +1083,54 @@ }, "type": "object" }, + "AuditConfig": { + "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, "Autoscale": { "description": "Auto scaling settings.", "id": "Autoscale", @@ -1016,18 +1154,18 @@ "id": "BiReservation", "properties": { "name": { - "description": "The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`.", + "description": "Identifier. The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`.", "type": "string" }, "preferredTables": { - "description": "Preferred tables to use BI capacity for.", + "description": "Optional. Preferred tables to use BI capacity for.", "items": { "$ref": "TableReference" }, "type": "array" }, "size": { - "description": "Size of a reservation, in bytes.", + "description": "Optional. Size of a reservation, in bytes.", "format": "int64", "type": "string" }, @@ -1040,6 +1178,28 @@ }, "type": "object" }, + "Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", + "type": "string" + } + }, + "type": "object" + }, "CapacityCommitment": { "description": "Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.", "id": "CapacityCommitment", @@ -1057,7 +1217,7 @@ "type": "string" }, "edition": { - "description": "Edition of the capacity commitment.", + "description": "Optional. Edition of the capacity commitment.", "enum": [ "EDITION_UNSPECIFIED", "STANDARD", @@ -1083,6 +1243,7 @@ "type": "boolean" }, "multiRegionAuxiliary": { + "deprecated": true, "description": "Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.", "type": "boolean" }, @@ -1092,7 +1253,7 @@ "type": "string" }, "plan": { - "description": "Capacity commitment commitment plan.", + "description": "Optional. Capacity commitment commitment plan.", "enum": [ "COMMITMENT_PLAN_UNSPECIFIED", "FLEX", @@ -1132,7 +1293,7 @@ "type": "string" }, "renewalPlan": { - "description": "The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.", + "description": "Optional. The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.", "enum": [ "COMMITMENT_PLAN_UNSPECIFIED", "FLEX", @@ -1172,7 +1333,7 @@ "type": "string" }, "slotCount": { - "description": "Number of slots in this commitment.", + "description": "Optional. Number of slots in this commitment.", "format": "int64", "type": "string" }, @@ -1202,6 +1363,29 @@ "properties": {}, "type": "object" }, + "Expr": { + "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": "string" + } + }, + "type": "object" + }, "FailoverReservationRequest": { "description": "The request for ReservationService.FailoverReservation.", "id": "FailoverReservationRequest", @@ -1295,6 +1479,37 @@ }, "type": "object" }, + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "ReplicationStatus": { "description": "Disaster Recovery(DR) replication status of the reservation.", "id": "ReplicationStatus", @@ -1464,6 +1679,22 @@ }, "type": "object" }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." + }, + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "SplitCapacityCommitmentRequest": { "description": "The request for ReservationService.SplitCapacityCommitment.", "id": "SplitCapacityCommitmentRequest", @@ -1523,19 +1754,47 @@ "id": "TableReference", "properties": { "datasetId": { - "description": "The ID of the dataset in the above project.", + "description": "Optional. The ID of the dataset in the above project.", "type": "string" }, "projectId": { - "description": "The assigned project ID of the project.", + "description": "Optional. The assigned project ID of the project.", "type": "string" }, "tableId": { - "description": "The ID of the table in the above dataset.", + "description": "Optional. The ID of the table in the above dataset.", "type": "string" } }, "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index a4bbe2d5e4..48ac51e697 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -192,7 +192,7 @@ "customEmojis": { "methods": { "create": { - "description": "Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis`", "flatPath": "v1/customEmojis", "httpMethod": "POST", "id": "chat.customEmojis.create", @@ -210,7 +210,7 @@ ] }, "delete": { - "description": "Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis`", "flatPath": "v1/customEmojis/{customEmojisId}", "httpMethod": "DELETE", "id": "chat.customEmojis.delete", @@ -235,7 +235,7 @@ ] }, "get": { - "description": "Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis`", "flatPath": "v1/customEmojis/{customEmojisId}", "httpMethod": "GET", "id": "chat.customEmojis.get", @@ -261,7 +261,7 @@ ] }, "list": { - "description": "Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis`", "flatPath": "v1/customEmojis", "httpMethod": "GET", "id": "chat.customEmojis.list", @@ -326,7 +326,7 @@ "supportsMediaDownload": true }, "upload": { - "description": "Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).", + "description": "Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat).", "flatPath": "v1/spaces/{spacesId}/attachments:upload", "httpMethod": "POST", "id": "chat.media.upload", @@ -377,7 +377,7 @@ "spaces": { "methods": { "completeImport": { - "description": "Completes the [import process](https://developers.google.com/workspace/chat/import-data) for the specified space and makes it visible to users. Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and domain-wide delegation. For more information, see [Authorize Google Chat apps to import data](https://developers.google.com/workspace/chat/authorize-import).", + "description": "Completes the [import process](https://developers.google.com/workspace/chat/import-data) for the specified space and makes it visible to users. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) and domain-wide delegation with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.import` For more information, see [Authorize Google Chat apps to import data](https://developers.google.com/workspace/chat/authorize-import).", "flatPath": "v1/spaces/{spacesId}:completeImport", "httpMethod": "POST", "id": "chat.spaces.completeImport", @@ -405,7 +405,7 @@ ] }, "create": { - "description": "Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When authenticating as an app, the `space.customer` field must be set in the request. Space membership upon creation depends on whether the space is created in `Import mode`: * **Import mode:** No members are created. * **All other modes:** The calling user is added as a member. This is: * The app itself when using app authentication. * The human user when using user authentication. If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.", + "description": "Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces.create` - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When authenticating as an app, the `space.customer` field must be set in the request. Space membership upon creation depends on whether the space is created in `Import mode`: * **Import mode:** No members are created. * **All other modes:** The calling user is added as a member. This is: * The app itself when using app authentication. * The human user when using user authentication. If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.", "flatPath": "v1/spaces", "httpMethod": "POST", "id": "chat.spaces.create", @@ -433,7 +433,7 @@ ] }, "delete": { - "description": "Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - Developer Preview: [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth). Requires that the Chat app created the space using app authentication. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request.", + "description": "Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.delete` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.delete` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.delete`", "flatPath": "v1/spaces/{spacesId}", "httpMethod": "DELETE", "id": "chat.spaces.delete", @@ -466,7 +466,7 @@ ] }, "findDirectMessage": { - "description": "Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. // Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)", + "description": "Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces`", "flatPath": "v1/spaces:findDirectMessage", "httpMethod": "GET", "id": "chat.spaces.findDirectMessage", @@ -489,7 +489,7 @@ ] }, "get": { - "description": "Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request.", + "description": "Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator approval](https://support.google.com/a?p=chat-app-auth) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces`", "flatPath": "v1/spaces/{spacesId}", "httpMethod": "GET", "id": "chat.spaces.get", @@ -524,7 +524,7 @@ ] }, "list": { - "description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.", + "description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.", "flatPath": "v1/spaces", "httpMethod": "GET", "id": "chat.spaces.list", @@ -558,7 +558,7 @@ ] }, "patch": { - "description": "Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request.", + "description": "Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces`", "flatPath": "v1/spaces/{spacesId}", "httpMethod": "PATCH", "id": "chat.spaces.patch", @@ -600,7 +600,7 @@ ] }, "search": { - "description": "Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges). In the request, set `use_admin_access` to `true`.", + "description": "Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` In the request, set `use_admin_access` to `true`.", "flatPath": "v1/spaces:search", "httpMethod": "GET", "id": "chat.spaces.search", @@ -643,7 +643,7 @@ ] }, "setup": { - "description": "Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group}`, where `{group}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces`", "flatPath": "v1/spaces:setup", "httpMethod": "POST", "id": "chat.spaces.setup", @@ -666,7 +666,7 @@ "members": { "methods": { "create": { - "description": "Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).", + "description": "Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to add the calling app to the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).", "flatPath": "v1/spaces/{spacesId}/members", "httpMethod": "POST", "id": "chat.spaces.members.create", @@ -703,7 +703,7 @@ ] }, "delete": { - "description": "Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the application must be the space creator.", + "description": "Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to remove the calling app from the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the application must be the space creator.", "flatPath": "v1/spaces/{spacesId}/members/{membersId}", "httpMethod": "DELETE", "id": "chat.spaces.members.delete", @@ -737,7 +737,7 @@ ] }, "get": { - "description": "Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request.", + "description": "Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`", "flatPath": "v1/spaces/{spacesId}/members/{membersId}", "httpMethod": "GET", "id": "chat.spaces.members.get", @@ -771,7 +771,7 @@ ] }, "list": { - "description": "Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request.", + "description": "Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`", "flatPath": "v1/spaces/{spacesId}/members", "httpMethod": "GET", "id": "chat.spaces.members.list", @@ -832,7 +832,7 @@ ] }, "patch": { - "description": "Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - Developer Preview: [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth). Requires that the Chat app created the space using app authentication. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request.", + "description": "Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships`", "flatPath": "v1/spaces/{spacesId}/members/{membersId}", "httpMethod": "PATCH", "id": "chat.spaces.members.patch", @@ -878,7 +878,7 @@ "messages": { "methods": { "create": { - "description": "Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). The `create()` method requires either [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authorize-import). Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`). ![Message sent with app authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`). ![Message sent with user authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) The maximum message size, including the message contents, is 32,000 bytes. For [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) requests, the response doesn't contain the full message. The response only populates the `name` and `thread.name` fields in addition to the information that was in the request.", + "description": "Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`). ![Message sent with app authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`). ![Message sent with user authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) The maximum message size, including the message contents, is 32,000 bytes. For [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) requests, the response doesn't contain the full message. The response only populates the `name` and `thread.name` fields in addition to the information that was in the request.", "flatPath": "v1/spaces/{spacesId}/messages", "httpMethod": "POST", "id": "chat.spaces.messages.create", @@ -940,7 +940,7 @@ ] }, "delete": { - "description": "Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only delete messages created by the calling Chat app.", + "description": "Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only delete messages created by the calling Chat app.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", "httpMethod": "DELETE", "id": "chat.spaces.messages.delete", @@ -972,7 +972,7 @@ ] }, "get": { - "description": "Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) Note: Might return a message from a blocked member or space.", + "description": "Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", "httpMethod": "GET", "id": "chat.spaces.messages.get", @@ -999,7 +999,7 @@ ] }, "list": { - "description": "Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)", "flatPath": "v1/spaces/{spacesId}/messages", "httpMethod": "GET", "id": "chat.spaces.messages.list", @@ -1052,7 +1052,7 @@ ] }, "patch": { - "description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only update messages created by the calling Chat app.", + "description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", "httpMethod": "PATCH", "id": "chat.spaces.messages.patch", @@ -1093,7 +1093,7 @@ ] }, "update": { - "description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only update messages created by the calling Chat app.", + "description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", "httpMethod": "PUT", "id": "chat.spaces.messages.update", @@ -1138,7 +1138,7 @@ "attachments": { "methods": { "get": { - "description": "Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download). For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-attachments). Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).", + "description": "Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download). For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-attachments). Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.bot`", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/attachments/{attachmentsId}", "httpMethod": "GET", "id": "chat.spaces.messages.attachments.get", @@ -1167,7 +1167,7 @@ "reactions": { "methods": { "create": { - "description": "Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.create` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions", "httpMethod": "POST", "id": "chat.spaces.messages.reactions.create", @@ -1198,7 +1198,7 @@ ] }, "delete": { - "description": "Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions/{reactionsId}", "httpMethod": "DELETE", "id": "chat.spaces.messages.reactions.delete", @@ -1225,7 +1225,7 @@ ] }, "list": { - "description": "Lists reactions to a message. For an example, see [List reactions for a message](https://developers.google.com/workspace/chat/list-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Lists reactions to a message. For an example, see [List reactions for a message](https://developers.google.com/workspace/chat/list-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages`", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}/reactions", "httpMethod": "GET", "id": "chat.spaces.messages.reactions.list", @@ -1275,7 +1275,7 @@ "spaceEvents": { "methods": { "get": { - "description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).", + "description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).", "flatPath": "v1/spaces/{spacesId}/spaceEvents/{spaceEventsId}", "httpMethod": "GET", "id": "chat.spaces.spaceEvents.get", @@ -1309,7 +1309,7 @@ ] }, "list": { - "description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).", + "description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).", "flatPath": "v1/spaces/{spacesId}/spaceEvents", "httpMethod": "GET", "id": "chat.spaces.spaceEvents.list", @@ -1367,7 +1367,7 @@ "spaces": { "methods": { "getSpaceReadState": { - "description": "Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`", "flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceReadState", "httpMethod": "GET", "id": "chat.users.spaces.getSpaceReadState", @@ -1393,7 +1393,7 @@ ] }, "updateSpaceReadState": { - "description": "Updates a user's read state within a space, used to identify read and unread messages. For an example, see [Update a user's space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Updates a user's read state within a space, used to identify read and unread messages. For an example, see [Update a user's space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate`", "flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceReadState", "httpMethod": "PATCH", "id": "chat.users.spaces.updateSpaceReadState", @@ -1431,7 +1431,7 @@ "spaceNotificationSetting": { "methods": { "get": { - "description": "Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`", "flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceNotificationSetting", "httpMethod": "GET", "id": "chat.users.spaces.spaceNotificationSetting.get", @@ -1456,7 +1456,7 @@ ] }, "patch": { - "description": "Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`", "flatPath": "v1/users/{usersId}/spaces/{spacesId}/spaceNotificationSetting", "httpMethod": "PATCH", "id": "chat.users.spaces.spaceNotificationSetting.patch", @@ -1494,7 +1494,7 @@ "threads": { "methods": { "getThreadReadState": { - "description": "Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`", "flatPath": "v1/users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState", "httpMethod": "GET", "id": "chat.users.spaces.threads.getThreadReadState", @@ -1526,7 +1526,7 @@ } } }, - "revision": "20250427", + "revision": "20250516", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2263,7 +2263,7 @@ "Default value. Unspecified.", "A user opens a dialog.", "A user clicks an interactive element of a dialog. For example, a user fills out information in a dialog and clicks a button to submit the information.", - "A user closes a dialog without submitting information. The Chat app only receives this interaction event when users click the close icon in the top right corner of the dialog. When the user closes the dialog by other means (such as refreshing the browser, clicking outside the dialog box, or pressing the escape key), no event is sent. ." + "" ], "type": "string" }, @@ -3468,9 +3468,6 @@ "description": "For multiselect menus, a text description or label that's displayed below the item's `text` field.", "type": "string" }, - "materialIcon": { - "$ref": "GoogleAppsCardV1MaterialIcon" - }, "selected": { "description": "Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.", "type": "boolean" diff --git a/discovery/chromepolicy-v1.json b/discovery/chromepolicy-v1.json index 610d40f519..50b321c713 100644 --- a/discovery/chromepolicy-v1.json +++ b/discovery/chromepolicy-v1.json @@ -557,7 +557,7 @@ } } }, - "revision": "20250409", + "revision": "20250504", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { @@ -1789,7 +1789,7 @@ "properties": { "editionDeprecated": { "deprecated": true, - "description": "BEGIN GOOGLE-INTERNAL TODO(b/297898292) Deprecate and remove this field in favor of enums. END GOOGLE-INTERNAL", + "description": "copybara:strip_begin TODO(b/297898292) Deprecate and remove this field in favor of enums. copybara:strip_end", "type": "string" }, "enumType": { diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index 4b830c8774..39a2d41c35 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -2573,7 +2573,7 @@ } } }, - "revision": "20250418", + "revision": "20250514", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -3591,6 +3591,10 @@ "description": "Human-readable description of this trigger.", "type": "string" }, + "developerConnectEventConfig": { + "$ref": "DeveloperConnectEventConfig", + "description": "Optional. The configuration of a trigger that creates a build whenever an event from the DeveloperConnect API is received." + }, "disabled": { "description": "If true, the trigger will never automatically execute a build.", "type": "boolean" @@ -4025,6 +4029,44 @@ }, "type": "object" }, + "DeveloperConnectEventConfig": { + "description": "The configuration of a trigger that creates a build whenever an event from the DeveloperConnect API is received.", + "id": "DeveloperConnectEventConfig", + "properties": { + "gitRepositoryLink": { + "description": "Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.", + "type": "string" + }, + "gitRepositoryLinkType": { + "description": "Output only. The type of DeveloperConnect GitRepositoryLink.", + "enum": [ + "GIT_REPOSITORY_LINK_TYPE_UNSPECIFIED", + "GITHUB", + "GITHUB_ENTERPRISE", + "GITLAB", + "GITLAB_ENTERPRISE" + ], + "enumDescriptions": [ + "If unspecified, GitRepositoryLinkType defaults to GITHUB.", + "The SCM repo is GITHUB.", + "The SCM repo is GITHUB_ENTERPRISE.", + "The SCM repo is GITLAB.", + "The SCM repo is GITLAB_ENTERPRISE." + ], + "readOnly": true, + "type": "string" + }, + "pullRequest": { + "$ref": "PullRequestFilter", + "description": "Filter to match changes in pull requests." + }, + "push": { + "$ref": "PushFilter", + "description": "Filter to match changes in refs like branches and tags." + } + }, + "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", @@ -4817,7 +4859,7 @@ "type": "string" }, "path": { - "description": "Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", + "description": "Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.", "type": "string" }, "repository": { @@ -5864,7 +5906,7 @@ }, "privatePoolV1Config": { "$ref": "PrivatePoolV1Config", - "description": "Legacy Private Pool configuration." + "description": "Private Pool configuration." }, "state": { "description": "Output only. `WorkerPool` state.", diff --git a/discovery/cloudfunctions-v1.json b/discovery/cloudfunctions-v1.json index 40494ab1f6..ec53f96f21 100644 --- a/discovery/cloudfunctions-v1.json +++ b/discovery/cloudfunctions-v1.json @@ -558,7 +558,7 @@ } } }, - "revision": "20250424", + "revision": "20250430", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -799,6 +799,16 @@ "description": "The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).", "type": "string" }, + "satisfiesPzi": { + "description": "Output only.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only.", + "readOnly": true, + "type": "boolean" + }, "secretEnvironmentVariables": { "description": "Secret environment variables configuration.", "items": { diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index e03bd09dd0..809dcecf82 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -103,6 +103,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://cloudkms.us.rep.googleapis.com/", "location": "us" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.in.rep.googleapis.com/", + "location": "in" } ], "fullyEncodeReservedExpansion": true, @@ -2158,7 +2163,7 @@ } } }, - "revision": "20250414", + "revision": "20250501", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -3551,7 +3556,7 @@ "type": "string" }, "totalSize": { - "description": "The total number of CryptoKeyVersions that matched the query.", + "description": "The total number of CryptoKeyVersions that matched the query. This field is not populated if ListCryptoKeyVersionsRequest.filter is applied.", "format": "int32", "type": "integer" } @@ -3574,7 +3579,7 @@ "type": "string" }, "totalSize": { - "description": "The total number of CryptoKeys that matched the query.", + "description": "The total number of CryptoKeys that matched the query. This field is not populated if ListCryptoKeysRequest.filter is applied.", "format": "int32", "type": "integer" } @@ -3597,7 +3602,7 @@ "type": "string" }, "totalSize": { - "description": "The total number of EkmConnections that matched the query.", + "description": "The total number of EkmConnections that matched the query. This field is not populated if ListEkmConnectionsRequest.filter is applied.", "format": "int32", "type": "integer" } @@ -3620,7 +3625,7 @@ "type": "string" }, "totalSize": { - "description": "The total number of ImportJobs that matched the query.", + "description": "The total number of ImportJobs that matched the query. This field is not populated if ListImportJobsRequest.filter is applied.", "format": "int32", "type": "integer" } @@ -3661,7 +3666,7 @@ "type": "string" }, "totalSize": { - "description": "The total number of KeyRings that matched the query.", + "description": "The total number of KeyRings that matched the query. This field is not populated if ListKeyRingsRequest.filter is applied.", "format": "int32", "type": "integer" } diff --git a/discovery/cloudresourcemanager-v3.json b/discovery/cloudresourcemanager-v3.json index 5408b0821a..4bacc81eb6 100644 --- a/discovery/cloudresourcemanager-v3.json +++ b/discovery/cloudresourcemanager-v3.json @@ -321,7 +321,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".", + "description": "Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1870,7 +1870,7 @@ } } }, - "revision": "20250417", + "revision": "20250508", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -2212,8 +2212,7 @@ "type": "string" }, "name": { - "description": "Output only. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".", - "readOnly": true, + "description": "Identifier. The resource name of the folder. Its format is `folders/{folder_id}`, for example: \"folders/1234\".", "type": "string" }, "parent": { diff --git a/discovery/composer-v1.json b/discovery/composer-v1.json index 70b51ebc29..cb1a5397f6 100644 --- a/discovery/composer-v1.json +++ b/discovery/composer-v1.json @@ -646,6 +646,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "restartWebServer": { + "description": "Restart Airflow web server.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:restartWebServer", + "httpMethod": "POST", + "id": "composer.projects.locations.environments.restartWebServer", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the environment to restart the web server for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:restartWebServer", + "request": { + "$ref": "RestartWebServerRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "saveSnapshot": { "description": "Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:saveSnapshot", @@ -1188,7 +1216,7 @@ } } }, - "revision": "20250303", + "revision": "20250513", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -2331,6 +2359,12 @@ }, "type": "object" }, + "RestartWebServerRequest": { + "description": "Restart Airflow web server.", + "id": "RestartWebServerRequest", + "properties": {}, + "type": "object" + }, "SaveSnapshotRequest": { "description": "Request to create a snapshot of a Cloud Composer environment.", "id": "SaveSnapshotRequest", diff --git a/discovery/composer-v1beta1.json b/discovery/composer-v1beta1.json index 236890ff31..420f8386c4 100644 --- a/discovery/composer-v1beta1.json +++ b/discovery/composer-v1beta1.json @@ -656,7 +656,7 @@ ], "parameters": { "name": { - "description": "The resource name of the environment to restart the web server for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", + "description": "Required. The resource name of the environment to restart the web server for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", "required": true, @@ -1216,7 +1216,7 @@ } } }, - "revision": "20250303", + "revision": "20250513", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index 3b82f49a08..0d7fb82285 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -748,6 +748,51 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "capacity": { + "description": "Advice on making real-time decisions (such as choosing zone or machine types) during deployment to maximize your chances of obtaining capacity.", + "flatPath": "projects/{project}/regions/{region}/advice/capacity", + "httpMethod": "POST", + "id": "compute.advice.capacity", + "parameterOrder": [ + "project", + "region", + "size" + ], + "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" + }, + "size": { + "description": "Size of requested capacity.", + "format": "int32", + "location": "query", + "required": true, + "type": "integer" + } + }, + "path": "projects/{project}/regions/{region}/advice/capacity", + "request": { + "$ref": "CapacityAdviceRequest" + }, + "response": { + "$ref": "CapacityAdviceResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, @@ -23667,30 +23712,30 @@ "methods": { "get": { "description": "Returns the details of the given PreviewFeature.", - "flatPath": "projects/{project}/global/previewFeatures/{resourceId}", + "flatPath": "projects/{project}/global/previewFeatures/{previewFeature}", "httpMethod": "GET", "id": "compute.previewFeatures.get", "parameterOrder": [ "project", - "resourceId" + "previewFeature" ], "parameters": { - "project": { - "description": "Project ID for this request.", + "previewFeature": { + "description": "Name of the PreviewFeature 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])?))", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, - "resourceId": { - "description": "Name of the PreviewFeature for this request.", + "project": { + "description": "Project ID for this request.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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/previewFeatures/{resourceId}", + "path": "projects/{project}/global/previewFeatures/{previewFeature}", "response": { "$ref": "PreviewFeature" }, @@ -23757,14 +23802,21 @@ }, "update": { "description": "Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.", - "flatPath": "projects/{project}/global/previewFeatures/{resourceId}", + "flatPath": "projects/{project}/global/previewFeatures/{previewFeature}", "httpMethod": "PATCH", "id": "compute.previewFeatures.update", "parameterOrder": [ "project", - "resourceId" + "previewFeature" ], "parameters": { + "previewFeature": { + "description": "Name of the PreviewFeature for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -23776,16 +23828,9 @@ "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" - }, - "resourceId": { - "description": "Name of the PreviewFeature for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" } }, - "path": "projects/{project}/global/previewFeatures/{resourceId}", + "path": "projects/{project}/global/previewFeatures/{previewFeature}", "request": { "$ref": "PreviewFeature" }, @@ -25238,7 +25283,465 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "Name of the region scoping 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" + } + }, + "path": "projects/{project}/regions/{region}/autoscalers", + "response": { + "$ref": "RegionAutoscalerList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/regions/{region}/autoscalers", + "httpMethod": "PATCH", + "id": "compute.regionAutoscalers.patch", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "autoscaler": { + "description": "Name of the autoscaler to patch.", + "location": "query", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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 scoping 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" + } + }, + "path": "projects/{project}/regions/{region}/autoscalers", + "request": { + "$ref": "Autoscaler" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionAutoscalers.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "update": { + "description": "Updates an autoscaler in the specified project using the data included in the request.", + "flatPath": "projects/{project}/regions/{region}/autoscalers", + "httpMethod": "PUT", + "id": "compute.regionAutoscalers.update", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "autoscaler": { + "description": "Name of the autoscaler to update.", + "location": "query", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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 scoping 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" + } + }, + "path": "projects/{project}/regions/{region}/autoscalers", + "request": { + "$ref": "Autoscaler" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "regionBackendBuckets": { + "methods": { + "delete": { + "description": "Deletes the specified regional BackendBucket resource.", + "flatPath": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}", + "httpMethod": "DELETE", + "id": "compute.regionBackendBuckets.delete", + "parameterOrder": [ + "project", + "region", + "backendBucket" + ], + "parameters": { + "backendBucket": { + "description": "Name of the BackendBucket resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "forceDelete": { + "description": "Force delete the backend bucket even if it is still in use by other resources. It's intended to be used internally only for requests from wipeout.", + "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 scoping 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). end_interface: MixerMutationRequestBuilder", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified regional BackendBucket resource.", + "flatPath": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}", + "httpMethod": "GET", + "id": "compute.regionBackendBuckets.get", + "parameterOrder": [ + "project", + "region", + "backendBucket" + ], + "parameters": { + "backendBucket": { + "description": "Name of the BackendBucket resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}", + "response": { + "$ref": "BackendBucket" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/regions/{region}/backendBuckets/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.regionBackendBuckets.getIamPolicy", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/backendBuckets/{resource}/getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a RegionBackendBucket in the specified project in the given scope using the parameters that are included in the request.", + "flatPath": "projects/{project}/regions/{region}/regionBackendBuckets", + "httpMethod": "POST", + "id": "compute.regionBackendBuckets.insert", + "parameterOrder": [ + "project", + "region" + ], + "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 of 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" + } + }, + "path": "projects/{project}/regions/{region}/regionBackendBuckets", + "request": { + "$ref": "BackendBucket" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves the list of BackendBucket resources available to the specified project in the given region.", + "flatPath": "projects/{project}/regions/{region}/backendBuckets", + "httpMethod": "GET", + "id": "compute.regionBackendBuckets.list", + "parameterOrder": [ + "project", + "region" + ], + "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 of 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" + } + }, + "path": "projects/{project}/regions/{region}/backendBuckets", + "response": { + "$ref": "BackendBucketList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "listUsable": { + "description": "Retrieves a list of all usable backend buckets in the specified project in the given region.", + "flatPath": "projects/{project}/regions/{region}/backendBuckets/listUsable", + "httpMethod": "GET", + "id": "compute.regionBackendBuckets.listUsable", + "parameterOrder": [ + "project", + "region" + ], + "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 scoping this request. It must be a string that meets the requirements in RFC1035.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -25250,9 +25753,9 @@ "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/autoscalers", + "path": "projects/{project}/regions/{region}/backendBuckets/listUsable", "response": { - "$ref": "RegionAutoscalerList" + "$ref": "BackendBucketListUsable" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -25261,19 +25764,21 @@ ] }, "patch": { - "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/regions/{region}/autoscalers", + "description": "Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}", "httpMethod": "PATCH", - "id": "compute.regionAutoscalers.patch", + "id": "compute.regionBackendBuckets.patch", "parameterOrder": [ "project", - "region" + "region", + "backendBucket" ], "parameters": { - "autoscaler": { - "description": "Name of the autoscaler to patch.", - "location": "query", + "backendBucket": { + "description": "Name of the BackendBucket resource to patch.", + "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, "type": "string" }, "project": { @@ -25291,14 +25796,14 @@ "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).", + "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). end_interface: MixerMutationRequestBuilder", "location": "query", "type": "string" } }, - "path": "projects/{project}/regions/{region}/autoscalers", + "path": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}", "request": { - "$ref": "Autoscaler" + "$ref": "BackendBucket" }, "response": { "$ref": "Operation" @@ -25308,11 +25813,11 @@ "https://www.googleapis.com/auth/compute" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy", "httpMethod": "POST", - "id": "compute.regionAutoscalers.testIamPermissions", + "id": "compute.regionBackendBuckets.setIamPolicy", "parameterOrder": [ "project", "region", @@ -25341,35 +25846,29 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy", "request": { - "$ref": "TestPermissionsRequest" + "$ref": "RegionSetPolicyRequest" }, "response": { - "$ref": "TestPermissionsResponse" + "$ref": "Policy" }, "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" ] }, - "update": { - "description": "Updates an autoscaler in the specified project using the data included in the request.", - "flatPath": "projects/{project}/regions/{region}/autoscalers", - "httpMethod": "PUT", - "id": "compute.regionAutoscalers.update", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionBackendBuckets.testIamPermissions", "parameterOrder": [ "project", - "region" + "region", + "resource" ], "parameters": { - "autoscaler": { - "description": "Name of the autoscaler to update.", - "location": "query", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "type": "string" - }, "project": { "description": "Project ID for this request.", "location": "path", @@ -25378,28 +25877,31 @@ "type": "string" }, "region": { - "description": "Name of the region scoping this request.", + "description": "The 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", + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, "type": "string" } }, - "path": "projects/{project}/regions/{region}/autoscalers", + "path": "projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions", "request": { - "$ref": "Autoscaler" + "$ref": "TestPermissionsRequest" }, "response": { - "$ref": "Operation" + "$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] } } @@ -49568,7 +50070,7 @@ } } }, - "revision": "20250427", + "revision": "20250511", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -53286,7 +53788,7 @@ "type": "string" }, "network": { - "description": "The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL.", + "description": "The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL, or when the load balancing scheme is set to EXTERNAL and haPolicy fastIpMove is enabled.", "type": "string" }, "networkPassThroughLbTrafficPolicy": { @@ -55271,6 +55773,207 @@ }, "type": "object" }, + "CapacityAdviceRequest": { + "description": "A request to provide Assistant Scores. These scores determine VM obtainability and preemption likelihood.", + "id": "CapacityAdviceRequest", + "properties": { + "distributionPolicy": { + "$ref": "CapacityAdviceRequestDistributionPolicy", + "description": "Policy specifying the distribution of instances across zones within the requested region." + }, + "instanceFlexibilityPolicy": { + "$ref": "CapacityAdviceRequestInstanceFlexibilityPolicy", + "description": "Policy for instance selectors." + }, + "instanceProperties": { + "$ref": "CapacityAdviceRequestInstanceProperties", + "description": "Instance properties for this request." + } + }, + "type": "object" + }, + "CapacityAdviceRequestDistributionPolicy": { + "id": "CapacityAdviceRequestDistributionPolicy", + "properties": { + "targetShape": { + "description": "The distribution shape to which the group converges.", + "enum": [ + "ANY", + "ANY_SINGLE_ZONE", + "BALANCED", + "TARGET_SHAPE_UNSPECIFIED" + ], + "enumDescriptions": [ + "The group picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.", + "The group creates all VM instances within a single zone. The zone is selected based on the present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads with heavy interprocess communication.", + "The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across selected zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.", + "" + ], + "type": "string" + }, + "zones": { + "description": "Zones where Capacity Advisor looks for capacity.", + "items": { + "$ref": "CapacityAdviceRequestDistributionPolicyZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, + "CapacityAdviceRequestDistributionPolicyZoneConfiguration": { + "id": "CapacityAdviceRequestDistributionPolicyZoneConfiguration", + "properties": { + "zone": { + "description": "The URL of the zone.", + "type": "string" + } + }, + "type": "object" + }, + "CapacityAdviceRequestInstanceFlexibilityPolicy": { + "description": "Specification of alternative, flexible instance subsets.", + "id": "CapacityAdviceRequestInstanceFlexibilityPolicy", + "properties": { + "instanceSelections": { + "additionalProperties": { + "$ref": "CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelection" + }, + "description": "Named instance selections configure properties. The key is an arbitrary, unique RFC1035 string that identifies the instance selection.", + "type": "object" + } + }, + "type": "object" + }, + "CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelection": { + "description": "Machine specification.", + "id": "CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelection", + "properties": { + "machineTypes": { + "description": "Full machine-type names, e.g. \"n1-standard-16\".", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CapacityAdviceRequestInstanceProperties": { + "description": "Instance provisining properties.", + "id": "CapacityAdviceRequestInstanceProperties", + "properties": { + "scheduling": { + "$ref": "CapacityAdviceRequestInstancePropertiesScheduling", + "description": "Specifies the scheduling options." + } + }, + "type": "object" + }, + "CapacityAdviceRequestInstancePropertiesScheduling": { + "description": "Defines the instance scheduling options.", + "id": "CapacityAdviceRequestInstancePropertiesScheduling", + "properties": { + "provisioningModel": { + "description": "Specifies the provisioning model of the instance.", + "enum": [ + "FLEX_START", + "RESERVATION_BOUND", + "SPOT", + "STANDARD" + ], + "enumDescriptions": [ + "Instance is provisioned using the Flex Start provisioning model and has a limited runtime.", + "Bound to the lifecycle of the reservation in which it is provisioned.", + "Heavily discounted, no guaranteed runtime.", + "Standard provisioning with user controlled runtime, no discounts." + ], + "type": "string" + } + }, + "type": "object" + }, + "CapacityAdviceResponse": { + "description": "A response contains multiple scoring recommendations.", + "id": "CapacityAdviceResponse", + "properties": { + "recommendations": { + "description": "Initially the API will provide one recommendation which balances the individual scores according to Google's preference.", + "items": { + "$ref": "CapacityAdviceResponseRecommendation" + }, + "type": "array" + } + }, + "type": "object" + }, + "CapacityAdviceResponseRecommendation": { + "id": "CapacityAdviceResponseRecommendation", + "properties": { + "scores": { + "$ref": "CapacityAdviceResponseRecommendationScores" + }, + "shards": { + "items": { + "$ref": "CapacityAdviceResponseRecommendationShard" + }, + "type": "array" + } + }, + "type": "object" + }, + "CapacityAdviceResponseRecommendationScores": { + "description": "The Scores message groups information about a shard of capacity.", + "id": "CapacityAdviceResponseRecommendationScores", + "properties": { + "obtainability": { + "description": "The obtainability score indicates the likelihood of successfully obtaining (provisioning) the requested number of VMs. The score range is 0.0 through 1.0. Higher is better.", + "format": "double", + "type": "number" + }, + "spotPreemption": { + "description": "The preemption score indicates the likelihood that your Spot VMs is preempted. For more information about the preemption process, see Preemption of Spot VMs. The score range is 0.0 through 1.0. Higher is better.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "CapacityAdviceResponseRecommendationShard": { + "description": "Shards represent blocks of uniform capacity in recommendations. Each shard is for a single zone, single instance selection, and a single machine shape. Each shard defines a size expressed as the number of VMs.", + "id": "CapacityAdviceResponseRecommendationShard", + "properties": { + "instanceCount": { + "format": "int32", + "type": "integer" + }, + "machineType": { + "description": "The machine type corresponds to the instance selection in the request.", + "type": "string" + }, + "provisioningModel": { + "description": "Provisioning model of the recommended capacity.", + "enum": [ + "FLEX_START", + "RESERVATION_BOUND", + "SPOT", + "STANDARD" + ], + "enumDescriptions": [ + "Instance is provisioned using the Flex Start provisioning model and has a limited runtime.", + "Bound to the lifecycle of the reservation in which it is provisioned.", + "Heavily discounted, no guaranteed runtime.", + "Standard provisioning with user controlled runtime, no discounts." + ], + "type": "string" + }, + "zone": { + "description": "The zone name for this shard.", + "type": "string" + } + }, + "type": "object" + }, "ChannelCredentials": { "description": "[Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server.", "id": "ChannelCredentials", @@ -62573,6 +63276,16 @@ "description": "Maintenance Info for ReservationBlocks.", "id": "GroupMaintenanceInfo", "properties": { + "instanceMaintenanceOngoingCount": { + "description": "Describes number of instances that have ongoing maintenance.", + "format": "int32", + "type": "integer" + }, + "instanceMaintenancePendingCount": { + "description": "Describes number of instances that have pending maintenance.", + "format": "int32", + "type": "integer" + }, "maintenanceOngoingCount": { "description": "Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.", "format": "int32", @@ -67429,7 +68142,7 @@ }, "targetSizePolicy": { "$ref": "InstanceGroupManagerTargetSizePolicy", - "description": "Configures how target size of MIG is achieved." + "description": "The policy that specifies how the MIG creates its VMs to achieve the target size." }, "targetSizeUnit": { "description": "The unit of measure for the target size.", @@ -67870,6 +68583,10 @@ "MIG automatically repairs an unhealthy VM by recreating it." ], "type": "string" + }, + "onRepair": { + "$ref": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair", + "description": "Configuration for VM repairs in the MIG." } }, "type": "object" @@ -67886,6 +68603,25 @@ }, "type": "object" }, + "InstanceGroupManagerInstanceLifecyclePolicyOnRepair": { + "description": "Configuration for VM repairs in the MIG.", + "id": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair", + "properties": { + "allowChangingZone": { + "description": "Specifies whether the MIG can change a VM's zone during repair.", + "enum": [ + "NO", + "YES" + ], + "enumDescriptions": [ + "[Default] MIG cannot change a VM's zone during repair.", + "MIG can select a different zone for the VM during repair." + ], + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagerList": { "description": "[Output Only] A list of managed instance groups.", "id": "InstanceGroupManagerList", @@ -68489,7 +69225,7 @@ }, "bulkInstanceOperation": { "$ref": "InstanceGroupManagerStatusBulkInstanceOperation", - "description": "[Output Only] Status of bulk instance operation." + "description": "[Output Only] The status of bulk instance operation." }, "isStable": { "description": "[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.", @@ -68521,6 +69257,7 @@ "type": "object" }, "InstanceGroupManagerStatusBulkInstanceOperation": { + "description": "Bulk instance operation is the creation of VMs in a MIG when the targetSizePolicy.mode is set to BULK.", "id": "InstanceGroupManagerStatusBulkInstanceOperation", "properties": { "inProgress": { @@ -68529,7 +69266,7 @@ }, "lastProgressCheck": { "$ref": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", - "description": "[Output Only] Information from last progress check of bulk instance operation." + "description": "[Output Only] Information from the last progress check of bulk instance operation." } }, "type": "object" @@ -68538,7 +69275,7 @@ "id": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", "properties": { "error": { - "description": "[Output Only] Contains errors encountered during bulk instance operation.", + "description": "[Output Only] Errors encountered during bulk instance operation.", "properties": { "errors": { "description": "[Output Only] The array of errors encountered while processing this operation.", @@ -68636,15 +69373,15 @@ "id": "InstanceGroupManagerTargetSizePolicy", "properties": { "mode": { - "description": "Mode in which operations on size are processed.", + "description": "The mode of target size policy based on which the MIG creates its VMs individually or all at once.", "enum": [ "BULK", "INDIVIDUAL", "UNSPECIFIED_MODE" ], "enumDescriptions": [ - "Mode in which MIG creates and starts VMs in all-or-nothing manner. If any VM from the request cannot be provisioned, the whole request waits for conditions that allow for provisioning whole capacity in bulk.", - "Default mode in which MIG creates and starts VMs individually without cross-dependency between VMs. This means that in case of something blocking part of VMs to be provisioned, the other part will be created.", + "The mode in which the MIG creates VMs all at once. In this mode, if the MIG is unable to create even one VM, the MIG waits until all VMs can be created at the same time.", + "The mode in which the MIG creates VMs individually. In this mode, if the MIG is unable to create a VM, the MIG will continue to create the other VMs in the group. This is the default mode.", "If mode is unspecified, MIG will behave as in the default `INDIVIDUAL` mode." ], "type": "string" @@ -72640,7 +73377,7 @@ "type": "object" }, "mtu": { - "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.", + "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.", "format": "int32", "type": "integer" }, @@ -73403,7 +74140,7 @@ "description": "L2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance." }, "mtu": { - "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.", + "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, or 8896. If not specified, the value will default to 1440.", "format": "int32", "type": "integer" }, @@ -92500,6 +93237,20 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "protectionTier": { + "description": "Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures).", + "enum": [ + "CAPACITY_OPTIMIZED", + "PROTECTION_TIER_UNSPECIFIED", + "STANDARD" + ], + "enumDescriptions": [ + "CAPACITY_OPTIMIZED capacity leverages redundancies (e.g. power, cooling) at the data center during normal operating conditions. In the event of infrastructure failures at data center (e.g. power and/or cooling failures), this workload may be disrupted. As a consequence, it has a weaker availability SLO than STANDARD.", + "Unspecified protection tier.", + "STANDARD protection for workload that should be protected by redundancies (e.g. power, cooling) at the data center level. In the event of infrastructure failures at data center (e.g. power and/or cooling failures), this workload is expected to continue as normal using the redundancies." + ], + "type": "string" + }, "reservationMode": { "description": "[Output only] Indicates the reservation mode of the reservation.", "enum": [ @@ -94774,7 +95525,7 @@ "type": "boolean" }, "enableOsInventoryMetadataValue": { - "description": "Effective enable-osinventory value at Instance level.", + "description": "Effective enable-os-inventory value at Instance level.", "type": "boolean" }, "enableOsconfigMetadataValue": { @@ -94789,6 +95540,10 @@ "description": "Effective serial-port-enable value at Instance level.", "type": "boolean" }, + "serialPortLoggingEnableMetadataValue": { + "description": "Effective serial-port-logging-enable value at Instance level.", + "type": "boolean" + }, "vmDnsSettingMetadataValue": { "description": "Effective VM DNS setting at Instance level.", "type": "string" @@ -98901,6 +99656,24 @@ "SecurityPolicyDdosProtectionConfig": { "id": "SecurityPolicyDdosProtectionConfig", "properties": { + "ddosAdaptiveProtection": { + "enum": [ + "DISABLED", + "ENABLED", + "PREVIEW" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "ddosImpactedBaselineThreshold": { + "description": "Adaptive Protection for Network Load Balancers (and VMs with public IPs) builds DDos mitigations that minimize collateral damage. It quantifies this as the fraction of a non-abuse baseline that's inadvertently blocked. Rules whose collateral damage exceeds ddosAdaptiveImpactedBaselineThreshold will not be deployed. Using a lower value will prioritize keeping collateral damage low, possibly at the cost of its effectiveness in rate limiting some or all of the attack. It should typically be between 0.01 and 0.10.", + "format": "float", + "type": "number" + }, "ddosProtection": { "enum": [ "ADVANCED", diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 0fd1904ffc..74ca0efd72 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -3083,6 +3083,54 @@ "https://www.googleapis.com/auth/compute" ] }, + "bulkSetLabels": { + "description": "Sets the labels on many disks at once. To learn more about labels, read the Labeling Resources documentation.", + "flatPath": "projects/{project}/zones/{zone}/disks/bulkSetLabels", + "httpMethod": "POST", + "id": "compute.disks.bulkSetLabels", + "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" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "query", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "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}/disks/bulkSetLabels", + "request": { + "$ref": "BulkZoneSetLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "createSnapshot": { "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", @@ -22645,6 +22693,142 @@ } } }, + "previewFeatures": { + "methods": { + "get": { + "description": "Returns the details of the given PreviewFeature.", + "flatPath": "projects/{project}/global/previewFeatures/{previewFeature}", + "httpMethod": "GET", + "id": "compute.previewFeatures.get", + "parameterOrder": [ + "project", + "previewFeature" + ], + "parameters": { + "previewFeature": { + "description": "Name of the PreviewFeature for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "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/previewFeatures/{previewFeature}", + "response": { + "$ref": "PreviewFeature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Returns the details of the given PreviewFeature.", + "flatPath": "projects/{project}/global/previewFeatures", + "httpMethod": "GET", + "id": "compute.previewFeatures.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/previewFeatures", + "response": { + "$ref": "PreviewFeatureList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "update": { + "description": "Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.", + "flatPath": "projects/{project}/global/previewFeatures/{previewFeature}", + "httpMethod": "PATCH", + "id": "compute.previewFeatures.update", + "parameterOrder": [ + "project", + "previewFeature" + ], + "parameters": { + "previewFeature": { + "description": "Name of the PreviewFeature for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "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" + } + }, + "path": "projects/{project}/global/previewFeatures/{previewFeature}", + "request": { + "$ref": "PreviewFeature" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "projects": { "methods": { "disableXpnHost": { @@ -45351,7 +45535,7 @@ } } }, - "revision": "20250427", + "revision": "20250511", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -48913,7 +49097,7 @@ "type": "string" }, "network": { - "description": "The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL.", + "description": "The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL, or when the load balancing scheme is set to EXTERNAL and haPolicy fastIpMove is enabled.", "type": "string" }, "networkPassThroughLbTrafficPolicy": { @@ -50632,6 +50816,36 @@ }, "type": "object" }, + "BulkSetLabelsRequest": { + "id": "BulkSetLabelsRequest", + "properties": { + "labelFingerprint": { + "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You may optionally provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels to set for this resource.", + "type": "object" + } + }, + "type": "object" + }, + "BulkZoneSetLabelsRequest": { + "id": "BulkZoneSetLabelsRequest", + "properties": { + "requests": { + "items": { + "$ref": "BulkSetLabelsRequest" + }, + "type": "array" + } + }, + "type": "object" + }, "BundledLocalSsds": { "id": "BundledLocalSsds", "properties": { @@ -50959,6 +51173,7 @@ "MEMORY_OPTIMIZED", "MEMORY_OPTIMIZED_M3", "MEMORY_OPTIMIZED_M4", + "MEMORY_OPTIMIZED_M4_6TB", "MEMORY_OPTIMIZED_X4_16TB", "MEMORY_OPTIMIZED_X4_24TB", "MEMORY_OPTIMIZED_X4_32TB", @@ -50994,6 +51209,7 @@ "", "", "", + "", "Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "type": "string" @@ -51879,6 +52095,28 @@ }, "type": "object" }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "DeprecationStatus": { "description": "Deprecation status for a public resource.", "id": "DeprecationStatus", @@ -54946,6 +55184,24 @@ ], "type": "string" }, + "destNetworkType": { + "description": "Network type of the traffic destination. Allowed values are: - UNSPECIFIED - INTERNET - NON_INTERNET ", + "enum": [ + "INTERNET", + "INTRA_VPC", + "NON_INTERNET", + "UNSPECIFIED", + "VPC_NETWORKS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, "destRegionCodes": { "description": "Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.\"US\" Maximum number of dest region codes allowed is 5000.", "items": { @@ -55006,6 +55262,24 @@ ], "type": "string" }, + "srcNetworkType": { + "description": "Network type of the traffic source. Allowed values are: - UNSPECIFIED - INTERNET - INTRA_VPC - NON_INTERNET - VPC_NETWORKS ", + "enum": [ + "INTERNET", + "INTRA_VPC", + "NON_INTERNET", + "UNSPECIFIED", + "VPC_NETWORKS" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, "srcNetworks": { "description": "Networks of the traffic source. It can be either a full or partial url.", "items": { @@ -60824,6 +61098,10 @@ "format": "int32", "type": "integer" }, + "targetSizePolicy": { + "$ref": "InstanceGroupManagerTargetSizePolicy", + "description": "The policy that specifies how the MIG creates its VMs to achieve the target size." + }, "targetStoppedSize": { "description": "The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. ", "format": "int32", @@ -61795,6 +62073,10 @@ "description": "[Output Only] The URL of the Autoscaler that targets this instance group manager.", "type": "string" }, + "bulkInstanceOperation": { + "$ref": "InstanceGroupManagerStatusBulkInstanceOperation", + "description": "[Output Only] The status of bulk instance operation." + }, "isStable": { "description": "[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.", "type": "boolean" @@ -61824,6 +62106,80 @@ }, "type": "object" }, + "InstanceGroupManagerStatusBulkInstanceOperation": { + "description": "Bulk instance operation is the creation of VMs in a MIG when the targetSizePolicy.mode is set to BULK.", + "id": "InstanceGroupManagerStatusBulkInstanceOperation", + "properties": { + "inProgress": { + "description": "[Output Only] Informs whether bulk instance operation is in progress.", + "type": "boolean" + }, + "lastProgressCheck": { + "$ref": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", + "description": "[Output Only] Information from the last progress check of bulk instance operation." + } + }, + "type": "object" + }, + "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck": { + "id": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", + "properties": { + "error": { + "description": "[Output Only] Errors encountered during bulk instance operation.", + "properties": { + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", + "items": { + "properties": { + "code": { + "description": "[Output Only] The error type identifier for this error.", + "type": "string" + }, + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "timestamp": { + "description": "[Output Only] Timestamp of the last progress check of bulk instance operation. Timestamp is in RFC3339 text format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagerStatusStateful": { "id": "InstanceGroupManagerStatusStateful", "properties": { @@ -61863,6 +62219,26 @@ }, "type": "object" }, + "InstanceGroupManagerTargetSizePolicy": { + "id": "InstanceGroupManagerTargetSizePolicy", + "properties": { + "mode": { + "description": "The mode of target size policy based on which the MIG creates its VMs individually or all at once.", + "enum": [ + "BULK", + "INDIVIDUAL", + "UNSPECIFIED_MODE" + ], + "enumDescriptions": [ + "The mode in which the MIG creates VMs all at once. In this mode, if the MIG is unable to create even one VM, the MIG waits until all VMs can be created at the same time.", + "The mode in which the MIG creates VMs individually. In this mode, if the MIG is unable to create a VM, the MIG will continue to create the other VMs in the group. This is the default mode.", + "If mode is unspecified, MIG will behave as in the default `INDIVIDUAL` mode." + ], + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagerUpdatePolicy": { "id": "InstanceGroupManagerUpdatePolicy", "properties": { @@ -65511,6 +65887,22 @@ ], "type": "string" }, + "candidateCloudRouterIpAddress": { + "description": "Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31. ", + "type": "string" + }, + "candidateCloudRouterIpv6Address": { + "description": "Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126. ", + "type": "string" + }, + "candidateCustomerRouterIpAddress": { + "description": "Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.", + "type": "string" + }, + "candidateCustomerRouterIpv6Address": { + "description": "Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.", + "type": "string" + }, "candidateIpv6Subnets": { "description": "This field is not available.", "items": { @@ -65631,7 +66023,7 @@ "type": "object" }, "mtu": { - "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.", + "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.", "format": "int32", "type": "integer" }, @@ -72866,6 +73258,18 @@ "format": "byte", "type": "string" }, + "igmpQuery": { + "description": "Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported.", + "enum": [ + "IGMP_QUERY_DISABLED", + "IGMP_QUERY_V2" + ], + "enumDescriptions": [ + "The network interface has disabled IGMP query.", + "The network interface has enabled IGMP query - v2." + ], + "type": "string" + }, "internalIpv6PrefixLength": { "description": "The prefix length of the primary internal IPv6 range.", "format": "int32", @@ -78257,6 +78661,342 @@ }, "type": "object" }, + "PreviewFeature": { + "description": "Represents a single Google Compute Engine preview feature.", + "id": "PreviewFeature", + "properties": { + "activationStatus": { + "description": "Specifies whether the feature is enabled or disabled.", + "enum": [ + "ACTIVATION_STATE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "[Output Only] Description of the feature.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#previewFeature", + "description": "[Output only] The type of the feature. Always \"compute#previewFeature\" for preview features.", + "type": "string" + }, + "name": { + "description": "Name of the feature.", + "type": "string" + }, + "rolloutOperation": { + "$ref": "PreviewFeatureRolloutOperation", + "description": "Rollout operation of the feature." + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "status": { + "$ref": "PreviewFeatureStatus", + "description": "[Output only] Status of the feature." + } + }, + "type": "object" + }, + "PreviewFeatureList": { + "id": "PreviewFeatureList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of PreviewFeature resources.", + "items": { + "$ref": "PreviewFeature" + }, + "type": "array" + }, + "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", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed 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", + "Quota information is not available to client requests (e.g: regions.list).", + "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" + }, + "PreviewFeatureRolloutOperation": { + "description": "Represents the rollout operation", + "id": "PreviewFeatureRolloutOperation", + "properties": { + "rolloutInput": { + "$ref": "PreviewFeatureRolloutOperationRolloutInput" + }, + "rolloutStatus": { + "$ref": "PreviewFeatureRolloutOperationRolloutStatus", + "readOnly": true + } + }, + "type": "object" + }, + "PreviewFeatureRolloutOperationRolloutInput": { + "id": "PreviewFeatureRolloutOperationRolloutInput", + "properties": { + "name": { + "description": "The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.", + "type": "string" + }, + "predefinedRolloutPlan": { + "description": "Predefined rollout plan.", + "enum": [ + "ROLLOUT_PLAN_FAST_ROLLOUT", + "ROLLOUT_PLAN_TWO_DAY_ROLLOUT", + "ROLLOUT_PLAN_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "retryUuid": { + "description": "The UUID of the retry action. Only needed if this is a retry for an existing rollout. This can be used after the user canceled a rollout and want to retry it with no changes.", + "type": "string" + } + }, + "type": "object" + }, + "PreviewFeatureRolloutOperationRolloutStatus": { + "id": "PreviewFeatureRolloutOperationRolloutStatus", + "properties": { + "ongoingRollouts": { + "description": "Output only. The ongoing rollout resources. There can be multiple ongoing rollouts for a resource.", + "items": { + "$ref": "PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata" + }, + "readOnly": true, + "type": "array" + }, + "previousRollout": { + "$ref": "PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata", + "description": "Output only. The last completed rollout resource. This field will not be populated until the first rollout is completed.", + "readOnly": true + } + }, + "type": "object" + }, + "PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata": { + "id": "PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata", + "properties": { + "rollout": { + "description": "The name of the rollout Ex. organizations//locations/global/rollouts/ Ex. folders//locations/global/rollouts/ Ex. projects//locations/global/rollouts/.", + "type": "string" + }, + "rolloutPlan": { + "description": "The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.", + "type": "string" + }, + "status": { + "$ref": "PreviewFeatureStatus", + "description": "The status of the rollout." + } + }, + "type": "object" + }, + "PreviewFeatureStatus": { + "description": "[Output Only] The status of the feature.", + "id": "PreviewFeatureStatus", + "properties": { + "description": { + "description": "[Output Only] The description of the feature.", + "type": "string" + }, + "releaseStatus": { + "$ref": "PreviewFeatureStatusReleaseStatus" + } + }, + "type": "object" + }, + "PreviewFeatureStatusReleaseStatus": { + "id": "PreviewFeatureStatusReleaseStatus", + "properties": { + "stage": { + "description": "[Output Only] The stage of the feature.", + "enum": [ + "DEPRECATED", + "GA", + "INTERNAL", + "PREVIEW", + "STAGE_UNSPECIFIED" + ], + "enumDescriptions": [ + "", + "", + "Exclude until there's product requirements.", + "", + "" + ], + "type": "string" + }, + "updateDate": { + "$ref": "Date", + "description": "Output only. The last date when a feature transitioned between ReleaseStatuses.", + "readOnly": true + } + }, + "type": "object" + }, "Project": { "description": "Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.", "id": "Project", diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index f21862d452..be661730fa 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -39717,7 +39717,7 @@ } } }, - "revision": "20250427", + "revision": "20250511", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -43055,7 +43055,7 @@ "type": "string" }, "network": { - "description": "The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL.", + "description": "The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL, or when the load balancing scheme is set to EXTERNAL and haPolicy fastIpMove is enabled.", "type": "string" }, "outlierDetection": { @@ -44926,6 +44926,7 @@ "MEMORY_OPTIMIZED", "MEMORY_OPTIMIZED_M3", "MEMORY_OPTIMIZED_M4", + "MEMORY_OPTIMIZED_M4_6TB", "MEMORY_OPTIMIZED_X4_16TB", "MEMORY_OPTIMIZED_X4_24TB", "MEMORY_OPTIMIZED_X4_32TB", @@ -44961,6 +44962,7 @@ "", "", "", + "", "Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "type": "string" @@ -47817,6 +47819,10 @@ "description": "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default ", "type": "string" }, + "params": { + "$ref": "FirewallParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "priority": { "description": "Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.", "format": "int32", @@ -48042,6 +48048,20 @@ }, "type": "object" }, + "FirewallParams": { + "description": "Additional firewall parameters.", + "id": "FirewallParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "FirewallPoliciesListAssociationsResponse": { "id": "FirewallPoliciesListAssociationsResponse", "properties": { @@ -57635,7 +57655,7 @@ "type": "object" }, "mtu": { - "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.", + "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.", "format": "int32", "type": "integer" }, @@ -74996,6 +75016,10 @@ "description": "The URL to a VpnTunnel that should handle matching packets.", "type": "string" }, + "params": { + "$ref": "RouteParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." + }, "priority": { "annotations": { "required": [ @@ -75369,6 +75393,20 @@ }, "type": "object" }, + "RouteParams": { + "description": "Additional route parameters.", + "id": "RouteParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"} * {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {\"123/environment\" : \"tagValues/444\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "RoutePolicy": { "id": "RoutePolicy", "properties": { diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index 84e29bc670..176a66dcd5 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -529,7 +529,7 @@ "type": "string" }, "updateMask": { - "description": "Required. You can modify only the fields listed below. To lock/unlock a connection: * `lock_config` To suspend/resume a connection: * `suspended` To update the connection details: * `description` * `labels` * `connector_version` * `config_variables` * `auth_config` * `destination_configs` * `node_config` * `log_config` * `ssl_config` * `eventing_enablement_type` * `eventing_config` * `auth_override_enabled`", + "description": "Required. The list of fields to update. Fields are specified relative to the connection. A field will be overwritten if it is in the mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. You can modify only the fields listed below. To lock/unlock a connection: * `lock_config` To suspend/resume a connection: * `suspended` To update the connection details: * `description` * `labels` * `connector_version` * `config_variables` * `auth_config` * `destination_configs` * `node_config` * `log_config` * `ssl_config` * `eventing_enablement_type` * `eventing_config` * `auth_override_enabled`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -873,6 +873,188 @@ } } }, + "endUserAuthentications": { + "methods": { + "create": { + "description": "Creates a new EndUserAuthentication in a given project,location and connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/endUserAuthentications", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.endUserAuthentications.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "endUserAuthenticationId": { + "description": "Required. Identifier to assign to the EndUserAuthentication. Must be unique within scope of the parent resource.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the EndUserAuthentication, of the form: `projects/*/locations/*/connections/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/endUserAuthentications", + "request": { + "$ref": "EndUserAuthentication" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single EndUserAuthentication.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/endUserAuthentications/{endUserAuthenticationsId}", + "httpMethod": "DELETE", + "id": "connectors.projects.locations.connections.endUserAuthentications.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*/endUserAuthentication/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/endUserAuthentications/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single EndUserAuthentication.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/endUserAuthentications/{endUserAuthenticationsId}", + "httpMethod": "GET", + "id": "connectors.projects.locations.connections.endUserAuthentications.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*/EndUserAuthentications/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/endUserAuthentications/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. View of the EndUserAuthentication to return.", + "enum": [ + "END_USER_AUTHENTICATION_VIEW_UNSPECIFIED", + "BASIC_VIEW", + "FULL_VIEW" + ], + "enumDescriptions": [ + "END_USER_AUTHENTICATION_UNSPECIFIED.", + "Do not include secret fields.", + "Include secret fields." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EndUserAuthentication" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List EndUserAuthentications in a given project,location and connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/endUserAuthentications", + "httpMethod": "GET", + "id": "connectors.projects.locations.connections.endUserAuthentications.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Order by parameters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the EndUserAuthentication, of the form: `projects/*/locations/*/connections/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/endUserAuthentications", + "response": { + "$ref": "ListEndUserAuthenticationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single EndUserAuthentication.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/endUserAuthentications/{endUserAuthenticationsId}", + "httpMethod": "PATCH", + "id": "connectors.projects.locations.connections.endUserAuthentications.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. Resource name of the EndUserAuthentication. Format: projects/{project}/locations/{location}/connections/{connection}/endUserAuthentications/{end_user_authentication}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/endUserAuthentications/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EndUserAuthentication details: * `notify_endpoint_destination`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "EndUserAuthentication" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "eventSubscriptions": { "methods": { "create": { @@ -1014,7 +1196,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}", + "description": "Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/eventSubscriptions/[^/]+$", "required": true, @@ -2418,6 +2600,21 @@ "required": true, "type": "string" }, + "schemaView": { + "description": "Optional. Enum to control whether schema enrichment related fields should be included in the response.", + "enum": [ + "CONNECTOR_VERSION_SCHEMA_VIEW_UNSPECIFIED", + "CONNECTOR_VERSION_SCHEMA_VIEW_BASIC", + "CONNECTOR_VERSION_SCHEMA_VIEW_ENRICHED" + ], + "enumDescriptions": [ + "VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.", + "Return basic connector version schema.", + "Return enriched connector version schema." + ], + "location": "query", + "type": "string" + }, "view": { "description": "Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `CUSTOMER` view.", "enum": [ @@ -2469,6 +2666,21 @@ "required": true, "type": "string" }, + "schemaView": { + "description": "Optional. Enum to control whether schema enrichment related fields should be included in the response.", + "enum": [ + "CONNECTOR_VERSION_SCHEMA_VIEW_UNSPECIFIED", + "CONNECTOR_VERSION_SCHEMA_VIEW_BASIC", + "CONNECTOR_VERSION_SCHEMA_VIEW_ENRICHED" + ], + "enumDescriptions": [ + "VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.", + "Return basic connector version schema.", + "Return enriched connector version schema." + ], + "location": "query", + "type": "string" + }, "view": { "description": "Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `BASIC` view.", "enum": [ @@ -2571,7 +2783,7 @@ } } }, - "revision": "20250423", + "revision": "20250507", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2627,18 +2839,18 @@ "id": "AuthConfig", "properties": { "additionalVariables": { - "description": "List containing additional auth configs.", + "description": "Optional. List containing additional auth configs.", "items": { "$ref": "ConfigVariable" }, "type": "array" }, "authKey": { - "description": "Identifier key for auth config", + "description": "Optional. Identifier key for auth config", "type": "string" }, "authType": { - "description": "The type of authentication configured.", + "description": "Optional. The type of authentication configured.", "enum": [ "AUTH_TYPE_UNSPECIFIED", "USER_PASSWORD", @@ -2970,7 +3182,7 @@ "type": "string" }, "key": { - "description": "Key of the config variable.", + "description": "Optional. Key of the config variable.", "type": "string" }, "secretValue": { @@ -3195,6 +3407,10 @@ "readOnly": true, "type": "string" }, + "euaOauthAuthConfig": { + "$ref": "AuthConfig", + "description": "Optional. Additional Oauth2.0 Auth config for EUA. If the connection is configured using non-OAuth authentication but OAuth needs to be used for EUA, this field can be populated with the OAuth config. This should be a OAuth2AuthCodeFlow Auth type only." + }, "eventingConfig": { "$ref": "EventingConfig", "description": "Optional. Eventing config of a connection" @@ -3218,6 +3434,10 @@ "description": "Output only. Eventing Runtime Data.", "readOnly": true }, + "fallbackOnAdminCredentials": { + "description": "Optional. Fallback on admin credentials for the connection. If this both auth_override_enabled and fallback_on_admin_credentials are set to true, the connection will use the admin credentials if the dynamic auth header is not present during auth override.", + "type": "boolean" + }, "host": { "description": "Output only. The name of the Hostname of the Service Directory service with TLS.", "readOnly": true, @@ -3594,6 +3814,20 @@ "description": "Indicate whether connector is being migrated to TLS.", "type": "boolean" }, + "networkEgressMode": { + "description": "Indicate whether connector is being migrated to use direct VPC egress.", + "enum": [ + "NETWORK_EGRESS_MODE_UNSPECIFIED", + "SERVERLESS_VPC_ACCESS_CONNECTOR", + "DIRECT_VPC_EGRESS" + ], + "enumDescriptions": [ + "Network egress mode is not specified.", + "Default model VPC Access Connector.", + "Direct VPC Egress." + ], + "type": "string" + }, "provisionCloudSpanner": { "description": "Indicate whether cloud spanner is required for connector job.", "type": "boolean" @@ -3725,6 +3959,13 @@ "readOnly": true, "type": "string" }, + "priorityEntityTypes": { + "description": "Optional. The priority entity types for the connector version.", + "items": { + "$ref": "PriorityEntityType" + }, + "type": "array" + }, "releaseVersion": { "description": "Output only. ReleaseVersion of the connector, for example: \"1.0.1-alpha\".", "readOnly": true, @@ -3907,7 +4148,7 @@ "id": "ConnectorsLogConfig", "properties": { "enabled": { - "description": "Enabled represents whether logging is enabled or not for a connection.", + "description": "Optional. Enabled represents whether logging is enabled or not for a connection.", "type": "boolean" }, "level": { @@ -4180,223 +4421,655 @@ }, "type": "object" }, - "DenyMaintenancePeriod": { - "description": "DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.", - "id": "DenyMaintenancePeriod", + "DenyMaintenancePeriod": { + "description": "DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "$ref": "Date", + "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. Allows recurring deny periods each year. Date matching this period will have to be before the end." + }, + "startDate": { + "$ref": "Date", + "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. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start." + }, + "time": { + "$ref": "TimeOfDay", + "description": "Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC" + } + }, + "type": "object" + }, + "DeprecateCustomConnectorVersionRequest": { + "description": "Request message for ConnectorsService.DeprecateCustomConnectorVersion", + "id": "DeprecateCustomConnectorVersionRequest", + "properties": {}, + "type": "object" + }, + "Destination": { + "id": "Destination", + "properties": { + "host": { + "description": "For publicly routable host.", + "type": "string" + }, + "port": { + "description": "The port is the target port number that is accepted by the destination.", + "format": "int32", + "type": "integer" + }, + "serviceAttachment": { + "deprecated": true, + "description": "PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*", + "type": "string" + } + }, + "type": "object" + }, + "DestinationConfig": { + "description": "Define the Connectors target endpoint.", + "id": "DestinationConfig", + "properties": { + "destinations": { + "description": "The destinations for the key.", + "items": { + "$ref": "Destination" + }, + "type": "array" + }, + "key": { + "description": "The key is the destination identifier that is supported by the Connector.", + "type": "string" + } + }, + "type": "object" + }, + "DestinationConfigTemplate": { + "description": "DestinationConfigTemplate defines required destinations supported by the Connector.", + "id": "DestinationConfigTemplate", + "properties": { + "autocompleteSuggestions": { + "description": "Autocomplete suggestions for destination URL field.", + "items": { + "type": "string" + }, + "type": "array" + }, + "defaultPort": { + "description": "The default port.", + "format": "int32", + "type": "integer" + }, + "description": { + "description": "Description.", + "type": "string" + }, + "displayName": { + "description": "Display name of the parameter.", + "type": "string" + }, + "isAdvanced": { + "description": "Whether the current destination tempalate is part of Advanced settings", + "type": "boolean" + }, + "key": { + "description": "Key of the destination.", + "type": "string" + }, + "max": { + "description": "The maximum number of destinations supported for this key.", + "format": "int32", + "type": "integer" + }, + "min": { + "description": "The minimum number of destinations supported for this key.", + "format": "int32", + "type": "integer" + }, + "portFieldType": { + "description": "Whether port number should be provided by customers.", + "enum": [ + "FIELD_TYPE_UNSPECIFIED", + "REQUIRED", + "OPTIONAL", + "NOT_USED" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "regexPattern": { + "description": "Regex pattern for host.", + "type": "string" + } + }, + "type": "object" + }, + "EUASecret": { + "description": "EUASecret provides a reference to entries in Secret Manager.", + "id": "EUASecret", + "properties": { + "secretValue": { + "description": "Optional. The plain string value of the secret.", + "type": "string" + }, + "secretVersion": { + "description": "Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.", + "type": "string" + } + }, + "type": "object" + }, + "EgressControlConfig": { + "description": "Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource.", + "id": "EgressControlConfig", + "properties": { + "backends": { + "description": "Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name).", + "type": "string" + }, + "extractionRules": { + "$ref": "ExtractionRules", + "description": "Extractions Rules to extract the backends from customer provided configuration." + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "EncryptionConfig": { + "description": "Regional encryption config for CMEK details.", + "id": "EncryptionConfig", + "properties": { + "encryptionType": { + "description": "Optional. Encryption type for the region.", + "enum": [ + "ENCRYPTION_TYPE_UNSPECIFIED", + "GMEK", + "CMEK" + ], + "enumDescriptions": [ + "Encryption type unspecified.", + "Google managed encryption keys", + "Customer managed encryption keys." + ], + "type": "string" + }, + "kmsKeyName": { + "description": "Optional. KMS crypto key. This field accepts identifiers of the form `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/ {crypto_key}`", + "type": "string" + } + }, + "type": "object" + }, + "EncryptionKey": { + "description": "Encryption Key value.", + "id": "EncryptionKey", + "properties": { + "kmsKeyName": { + "description": "Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.", + "type": "string" + }, + "type": { + "description": "Type.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_MANAGED", + "CUSTOMER_MANAGED" + ], + "enumDescriptions": [ + "Value type is not specified.", + "Google Managed.", + "Customer Managed." + ], + "type": "string" + } + }, + "type": "object" + }, + "EndPoint": { + "description": "Endpoint message includes details of the Destination endpoint.", + "id": "EndPoint", + "properties": { + "endpointUri": { + "description": "Optional. The URI of the Endpoint.", + "type": "string" + }, + "headers": { + "description": "Optional. List of Header to be added to the Endpoint.", + "items": { + "$ref": "Header" + }, + "type": "array" + } + }, + "type": "object" + }, + "EndUserAuthentication": { + "description": "AuthConfig defines details of a authentication type.", + "id": "EndUserAuthentication", + "properties": { + "configVariables": { + "description": "Optional. Config variables for the EndUserAuthentication.", + "items": { + "$ref": "EndUserAuthenticationConfigVariable" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. Created time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "destinationConfigs": { + "description": "Optional. Destination configs for the EndUserAuthentication.", + "items": { + "$ref": "DestinationConfig" + }, + "type": "array" + }, + "endUserAuthenticationConfig": { + "$ref": "EndUserAuthenticationConfig", + "description": "Optional. The EndUserAuthenticationConfig for the EndUserAuthentication." + }, + "labels": { + "description": "Optional. Labels for the EndUserAuthentication.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Required. Identifier. Resource name of the EndUserAuthentication. Format: projects/{project}/locations/{location}/connections/{connection}/endUserAuthentications/{end_user_authentication}", + "type": "string" + }, + "notifyEndpointDestination": { + "$ref": "EndUserAuthenticationNotifyEndpointDestination", + "description": "Optional. The destination to hit when we receive an event" + }, + "roles": { + "description": "Optional. Roles for the EndUserAuthentication.", + "items": { + "enum": [ + "ROLE_UNSPECIFIED", + "READER", + "READER_DOMAIN_WIDE_ACCESSIBLE" + ], + "enumDescriptions": [ + "Default state.", + "READER.", + "READER_DOMAIN_WIDE_ACCESSIBLE which has access to only public data." + ], + "type": "string" + }, + "type": "array" + }, + "status": { + "$ref": "EndUserAuthenticationEndUserAuthenticationStatus", + "description": "Optional. Status of the EndUserAuthentication." + }, + "updateTime": { + "description": "Output only. Updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "userId": { + "description": "Optional. The user id of the user.", + "type": "string" + } + }, + "type": "object" + }, + "EndUserAuthenticationConfig": { + "description": "EndUserAuthenticationConfig defines details of a authentication configuration for EUC", + "id": "EndUserAuthenticationConfig", + "properties": { + "additionalVariables": { + "description": "Optional. List containing additional auth configs.", + "items": { + "$ref": "EndUserAuthenticationConfigVariable" + }, + "type": "array" + }, + "authKey": { + "description": "Identifier key for auth config", + "type": "string" + }, + "authType": { + "description": "The type of authentication configured.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "USER_PASSWORD", + "OAUTH2_JWT_BEARER", + "OAUTH2_CLIENT_CREDENTIALS", + "SSH_PUBLIC_KEY", + "OAUTH2_AUTH_CODE_FLOW", + "GOOGLE_AUTHENTICATION", + "OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "Username and Password Authentication.", + "JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication", + "Oauth 2.0 Client Credentials Grant Authentication", + "SSH Public Key Authentication", + "Oauth 2.0 Authorization Code Flow", + "Google authentication", + "Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" + ], + "type": "string" + }, + "oauth2AuthCodeFlow": { + "$ref": "EndUserAuthenticationConfigOauth2AuthCodeFlow", + "description": "Oauth2AuthCodeFlow." + }, + "oauth2AuthCodeFlowGoogleManaged": { + "$ref": "EndUserAuthenticationConfigOauth2AuthCodeFlowGoogleManaged", + "description": "Oauth2AuthCodeFlowGoogleManaged." + }, + "oauth2ClientCredentials": { + "$ref": "EndUserAuthenticationConfigOauth2ClientCredentials", + "description": "Oauth2ClientCredentials." + }, + "oauth2JwtBearer": { + "$ref": "EndUserAuthenticationConfigOauth2JwtBearer", + "description": "Oauth2JwtBearer." + }, + "sshPublicKey": { + "$ref": "EndUserAuthenticationConfigSshPublicKey", + "description": "SSH Public Key." + }, + "userPassword": { + "$ref": "EndUserAuthenticationConfigUserPassword", + "description": "UserPassword." + } + }, + "type": "object" + }, + "EndUserAuthenticationConfigOauth2AuthCodeFlow": { + "description": "Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details.", + "id": "EndUserAuthenticationConfigOauth2AuthCodeFlow", + "properties": { + "authCode": { + "description": "Optional. Authorization code to be exchanged for access and refresh tokens.", + "type": "string" + }, + "authUri": { + "description": "Optional. Auth URL for Authorization Code Flow", + "type": "string" + }, + "clientId": { + "description": "Optional. Client ID for user-provided OAuth app.", + "type": "string" + }, + "clientSecret": { + "$ref": "EUASecret", + "description": "Optional. Client secret for user-provided OAuth app." + }, + "enablePkce": { + "description": "Optional. Whether to enable PKCE when the user performs the auth code flow.", + "type": "boolean" + }, + "oauthTokenData": { + "$ref": "OAuthTokenData", + "description": "Optional. Auth Code Data" + }, + "pkceVerifier": { + "description": "Optional. PKCE verifier to be used during the auth code exchange.", + "type": "string" + }, + "redirectUri": { + "description": "Optional. Redirect URI to be provided during the auth code exchange.", + "type": "string" + }, + "scopes": { + "description": "Optional. Scopes the connection will request when the user performs the auth code flow.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EndUserAuthenticationConfigOauth2AuthCodeFlowGoogleManaged": { + "description": "Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details.", + "id": "EndUserAuthenticationConfigOauth2AuthCodeFlowGoogleManaged", + "properties": { + "authCode": { + "description": "Optional. Authorization code to be exchanged for access and refresh tokens.", + "type": "string" + }, + "oauthTokenData": { + "$ref": "OAuthTokenData", + "description": "Auth Code Data" + }, + "redirectUri": { + "description": "Optional. Redirect URI to be provided during the auth code exchange.", + "type": "string" + }, + "scopes": { + "description": "Required. Scopes the connection will request when the user performs the auth code flow.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EndUserAuthenticationConfigOauth2ClientCredentials": { + "description": "Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.", + "id": "EndUserAuthenticationConfigOauth2ClientCredentials", + "properties": { + "clientId": { + "description": "The client identifier.", + "type": "string" + }, + "clientSecret": { + "$ref": "EUASecret", + "description": "Required. string value or secret version containing the client secret." + } + }, + "type": "object" + }, + "EndUserAuthenticationConfigOauth2JwtBearer": { + "description": "Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details.", + "id": "EndUserAuthenticationConfigOauth2JwtBearer", + "properties": { + "clientKey": { + "$ref": "EUASecret", + "description": "Required. secret version/value reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/strings/*/versions/*`." + }, + "jwtClaims": { + "$ref": "EndUserAuthenticationConfigOauth2JwtBearerJwtClaims", + "description": "JwtClaims providers fields to generate the token." + } + }, + "type": "object" + }, + "EndUserAuthenticationConfigOauth2JwtBearerJwtClaims": { + "description": "JWT claims used for the jwt-bearer authorization grant.", + "id": "EndUserAuthenticationConfigOauth2JwtBearerJwtClaims", "properties": { - "endDate": { - "$ref": "Date", - "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. Allows recurring deny periods each year. Date matching this period will have to be before the end." + "audience": { + "description": "Value for the \"aud\" claim.", + "type": "string" }, - "startDate": { - "$ref": "Date", - "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. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start." + "issuer": { + "description": "Value for the \"iss\" claim.", + "type": "string" }, - "time": { - "$ref": "TimeOfDay", - "description": "Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC" + "subject": { + "description": "Value for the \"sub\" claim.", + "type": "string" } }, "type": "object" }, - "DeprecateCustomConnectorVersionRequest": { - "description": "Request message for ConnectorsService.DeprecateCustomConnectorVersion", - "id": "DeprecateCustomConnectorVersionRequest", - "properties": {}, - "type": "object" - }, - "Destination": { - "id": "Destination", + "EndUserAuthenticationConfigSshPublicKey": { + "description": "Parameters to support Ssh public key Authentication.", + "id": "EndUserAuthenticationConfigSshPublicKey", "properties": { - "host": { - "description": "For publicly routable host.", + "certType": { + "description": "Format of SSH Client cert.", "type": "string" }, - "port": { - "description": "The port is the target port number that is accepted by the destination.", - "format": "int32", - "type": "integer" + "sshClientCert": { + "$ref": "EUASecret", + "description": "Required. SSH Client Cert. It should contain both public and private key." }, - "serviceAttachment": { - "deprecated": true, - "description": "PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*", + "sshClientCertPass": { + "$ref": "EUASecret", + "description": "Required. Password (passphrase) for ssh client certificate if it has one." + }, + "username": { + "description": "The user account used to authenticate.", "type": "string" } }, "type": "object" }, - "DestinationConfig": { - "description": "Define the Connectors target endpoint.", - "id": "DestinationConfig", + "EndUserAuthenticationConfigUserPassword": { + "description": "Parameters to support Username and Password Authentication.", + "id": "EndUserAuthenticationConfigUserPassword", "properties": { - "destinations": { - "description": "The destinations for the key.", - "items": { - "$ref": "Destination" - }, - "type": "array" + "password": { + "$ref": "EUASecret", + "description": "Required. string value or secret version reference containing the password." }, - "key": { - "description": "The key is the destination identifier that is supported by the Connector.", + "username": { + "description": "Username.", "type": "string" } }, "type": "object" }, - "DestinationConfigTemplate": { - "description": "DestinationConfigTemplate defines required destinations supported by the Connector.", - "id": "DestinationConfigTemplate", + "EndUserAuthenticationConfigVariable": { + "description": "EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication.", + "id": "EndUserAuthenticationConfigVariable", "properties": { - "autocompleteSuggestions": { - "description": "Autocomplete suggestions for destination URL field.", - "items": { - "type": "string" - }, - "type": "array" - }, - "defaultPort": { - "description": "The default port.", - "format": "int32", - "type": "integer" - }, - "description": { - "description": "Description.", - "type": "string" + "boolValue": { + "description": "Value is a bool.", + "type": "boolean" }, - "displayName": { - "description": "Display name of the parameter.", + "intValue": { + "description": "Value is an integer", + "format": "int64", "type": "string" }, - "isAdvanced": { - "description": "Whether the current destination tempalate is part of Advanced settings", - "type": "boolean" - }, "key": { - "description": "Key of the destination.", + "description": "Required. Key of the config variable.", "type": "string" }, - "max": { - "description": "The maximum number of destinations supported for this key.", - "format": "int32", - "type": "integer" - }, - "min": { - "description": "The minimum number of destinations supported for this key.", - "format": "int32", - "type": "integer" - }, - "portFieldType": { - "description": "Whether port number should be provided by customers.", - "enum": [ - "FIELD_TYPE_UNSPECIFIED", - "REQUIRED", - "OPTIONAL", - "NOT_USED" - ], - "enumDescriptions": [ - "", - "", - "", - "" - ], - "type": "string" + "secretValue": { + "$ref": "EUASecret", + "description": "Value is a secret" }, - "regexPattern": { - "description": "Regex pattern for host.", + "stringValue": { + "description": "Value is a string.", "type": "string" } }, "type": "object" }, - "EgressControlConfig": { - "description": "Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource.", - "id": "EgressControlConfig", + "EndUserAuthenticationEndUserAuthenticationStatus": { + "description": "EndUserAuthentication Status denotes the status of the EndUserAuthentication resource.", + "id": "EndUserAuthenticationEndUserAuthenticationStatus", "properties": { - "backends": { - "description": "Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name).", + "description": { + "description": "Output only. Description of the state.", + "readOnly": true, "type": "string" }, - "extractionRules": { - "$ref": "ExtractionRules", - "description": "Extractions Rules to extract the backends from customer provided configuration." - } - }, - "type": "object" - }, - "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "EncryptionConfig": { - "description": "Regional encryption config for CMEK details.", - "id": "EncryptionConfig", - "properties": { - "encryptionType": { - "description": "Optional. Encryption type for the region.", + "state": { + "description": "Output only. State of Event Subscription resource.", "enum": [ - "ENCRYPTION_TYPE_UNSPECIFIED", - "GMEK", - "CMEK" + "STATE_UNSPECIFIED", + "ACTIVE", + "ERROR" ], "enumDescriptions": [ - "Encryption type unspecified.", - "Google managed encryption keys", - "Customer managed encryption keys." + "Default state.", + "EndUserAuthentication is in Active state.", + "EndUserAuthentication is in Error state." ], - "type": "string" - }, - "kmsKeyName": { - "description": "Optional. KMS crypto key. This field accepts identifiers of the form `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/ {crypto_key}`", + "readOnly": true, "type": "string" } }, "type": "object" }, - "EncryptionKey": { - "description": "Encryption Key value.", - "id": "EncryptionKey", + "EndUserAuthenticationNotifyEndpointDestination": { + "description": "Message for NotifyEndpointDestination Destination to hit when the refresh token is expired.", + "id": "EndUserAuthenticationNotifyEndpointDestination", "properties": { - "kmsKeyName": { - "description": "The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.", + "endpoint": { + "$ref": "EndUserAuthenticationNotifyEndpointDestinationEndPoint", + "description": "Optional. OPTION 1: Hit an endpoint when the refresh token is expired." + }, + "serviceAccount": { + "description": "Required. Service account needed for runtime plane to notify the backend.", "type": "string" }, "type": { - "description": "Type.", + "description": "Required. type of the destination", "enum": [ "TYPE_UNSPECIFIED", - "GOOGLE_MANAGED", - "CUSTOMER_MANAGED" + "ENDPOINT" ], "enumDescriptions": [ - "Value type is not specified.", - "Google Managed.", - "Customer Managed." + "Default state.", + "Endpoint - Hit the value of endpoint when event is received" ], "type": "string" } }, "type": "object" }, - "EndPoint": { + "EndUserAuthenticationNotifyEndpointDestinationEndPoint": { "description": "Endpoint message includes details of the Destination endpoint.", - "id": "EndPoint", + "id": "EndUserAuthenticationNotifyEndpointDestinationEndPoint", "properties": { "endpointUri": { - "description": "The URI of the Endpoint.", + "description": "Required. The URI of the Endpoint.", "type": "string" }, "headers": { - "description": "List of Header to be added to the Endpoint.", + "description": "Optional. List of Header to be added to the Endpoint.", "items": { - "$ref": "Header" + "$ref": "EndUserAuthenticationNotifyEndpointDestinationEndPointHeader" }, "type": "array" } }, "type": "object" }, + "EndUserAuthenticationNotifyEndpointDestinationEndPointHeader": { + "description": "Header details for a given header to be added to Endpoint.", + "id": "EndUserAuthenticationNotifyEndpointDestinationEndPointHeader", + "properties": { + "key": { + "description": "Required. Key of Header.", + "type": "string" + }, + "value": { + "description": "Required. Value of Header.", + "type": "string" + } + }, + "type": "object" + }, "EndpointAttachment": { "description": "represents the Connector's Endpoint Attachment resource", "id": "EndpointAttachment", @@ -4519,7 +5192,7 @@ "description": "Optional. JMS is the source for the event listener." }, "name": { - "description": "Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}", + "description": "Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}", "type": "string" }, "status": { @@ -4563,11 +5236,11 @@ "description": "OPTION 3: Write the event to Pub/Sub topic." }, "serviceAccount": { - "description": "Service account needed for runtime plane to trigger IP workflow.", + "description": "Optional. Service account needed for runtime plane to trigger IP workflow.", "type": "string" }, "type": { - "description": "type of the destination", + "description": "Optional. type of the destination", "enum": [ "TYPE_UNSPECIFIED", "ENDPOINT", @@ -5259,11 +5932,11 @@ "id": "Header", "properties": { "key": { - "description": "Key of Header.", + "description": "Optional. Key of Header.", "type": "string" }, "value": { - "description": "Value of Header.", + "description": "Optional. Value of Header.", "type": "string" } }, @@ -5820,15 +6493,15 @@ "id": "JwtClaims", "properties": { "audience": { - "description": "Value for the \"aud\" claim.", + "description": "Optional. Value for the \"aud\" claim.", "type": "string" }, "issuer": { - "description": "Value for the \"iss\" claim.", + "description": "Optional. Value for the \"iss\" claim.", "type": "string" }, "subject": { - "description": "Value for the \"sub\" claim.", + "description": "Optional. Value for the \"sub\" claim.", "type": "string" } }, @@ -5977,6 +6650,31 @@ }, "type": "object" }, + "ListEndUserAuthenticationsResponse": { + "description": "Response message for ConnectorsService.ListEndUserAuthentications", + "id": "ListEndUserAuthenticationsResponse", + "properties": { + "endUserAuthentications": { + "description": "Subscriptions.", + "items": { + "$ref": "EndUserAuthentication" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Next page token.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListEndpointAttachmentsResponse": { "description": "Response message for ConnectorsService.ListEndpointAttachments", "id": "ListEndpointAttachmentsResponse", @@ -6245,11 +6943,11 @@ "id": "LockConfig", "properties": { "locked": { - "description": "Indicates whether or not the connection is locked.", + "description": "Optional. Indicates whether or not the connection is locked.", "type": "boolean" }, "reason": { - "description": "Describes why a connection is locked.", + "description": "Optional. Describes why a connection is locked.", "type": "string" } }, @@ -6557,12 +7255,12 @@ "id": "NodeConfig", "properties": { "maxNodeCount": { - "description": "Maximum number of nodes in the runtime nodes.", + "description": "Optional. Maximum number of nodes in the runtime nodes.", "format": "int32", "type": "integer" }, "minNodeCount": { - "description": "Minimum number of nodes in the runtime nodes.", + "description": "Optional. Minimum number of nodes in the runtime nodes.", "format": "int32", "type": "integer" } @@ -6602,40 +7300,65 @@ }, "type": "object" }, + "OAuthTokenData": { + "description": "pass only at create and not update using updateMask Auth Code Data", + "id": "OAuthTokenData", + "properties": { + "accessToken": { + "$ref": "EUASecret", + "description": "Optional. Access token for the connection." + }, + "createTime": { + "description": "Optional. Timestamp when the access token was created.", + "format": "google-datetime", + "type": "string" + }, + "expiry": { + "description": "Optional. Time in seconds when the access token expires.", + "format": "google-duration", + "type": "string" + }, + "refreshToken": { + "$ref": "EUASecret", + "description": "Optional. Refresh token for the connection." + } + }, + "type": "object" + }, "Oauth2AuthCodeFlow": { "description": "Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details.", "id": "Oauth2AuthCodeFlow", "properties": { "authCode": { - "description": "Authorization code to be exchanged for access and refresh tokens.", + "description": "Optional. Authorization code to be exchanged for access and refresh tokens.", "type": "string" }, "authUri": { - "description": "Auth URL for Authorization Code Flow", + "description": "Optional. Auth URL for Authorization Code Flow", "type": "string" }, "clientId": { - "description": "Client ID for user-provided OAuth app.", + "description": "Optional. Client ID for user-provided OAuth app.", "type": "string" }, "clientSecret": { "$ref": "Secret", - "description": "Client secret for user-provided OAuth app." + "description": "Optional. Client secret for user-provided OAuth app." }, "enablePkce": { - "description": "Whether to enable PKCE when the user performs the auth code flow.", + "description": "Optional. Whether to enable PKCE when the user performs the auth code flow.", "type": "boolean" }, "pkceVerifier": { - "description": "PKCE verifier to be used during the auth code exchange.", + "description": "Optional. PKCE verifier to be used during the auth code exchange.", "type": "string" }, "redirectUri": { - "description": "Redirect URI to be provided during the auth code exchange.", + "description": "Optional. Redirect URI to be provided during the auth code exchange.", "type": "string" }, "scopes": { - "description": "Scopes the connection will request when the user performs the auth code flow.", + "description": "Optional. Scopes the connection will request when the user performs the auth code flow.", "items": { "type": "string" }, @@ -6671,12 +7394,12 @@ "id": "Oauth2ClientCredentials", "properties": { "clientId": { - "description": "The client identifier.", + "description": "Optional. The client identifier.", "type": "string" }, "clientSecret": { "$ref": "Secret", - "description": "Secret version reference containing the client secret." + "description": "Optional. Secret version reference containing the client secret." } }, "type": "object" @@ -6687,11 +7410,11 @@ "properties": { "clientKey": { "$ref": "Secret", - "description": "Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`." + "description": "Optional. Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`." }, "jwtClaims": { "$ref": "JwtClaims", - "description": "JwtClaims providers fields to generate the token." + "description": "Optional. JwtClaims providers fields to generate the token." } }, "type": "object" @@ -6899,6 +7622,30 @@ }, "type": "object" }, + "PriorityEntityType": { + "description": "PriorityEntityType represents an entity type with its associated priority and order.", + "id": "PriorityEntityType", + "properties": { + "description": { + "description": "The description of the entity type.", + "type": "string" + }, + "id": { + "description": "The entity type.", + "type": "string" + }, + "order": { + "description": "The order of the entity type within its priority group.", + "format": "int32", + "type": "integer" + }, + "priority": { + "description": "The priority of the entity type, such as P0, P1, etc.", + "type": "string" + } + }, + "type": "object" + }, "Provider": { "description": "Provider indicates the owner who provides the connectors.", "id": "Provider", @@ -7681,7 +8428,7 @@ "id": "Secret", "properties": { "secretVersion": { - "description": "The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.", + "description": "Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.", "type": "string" } }, @@ -7794,19 +8541,19 @@ "id": "SshPublicKey", "properties": { "certType": { - "description": "Format of SSH Client cert.", + "description": "Optional. Format of SSH Client cert.", "type": "string" }, "sshClientCert": { "$ref": "Secret", - "description": "SSH Client Cert. It should contain both public and private key." + "description": "Optional. SSH Client Cert. It should contain both public and private key." }, "sshClientCertPass": { "$ref": "Secret", - "description": "Password (passphrase) for ssh client certificate if it has one." + "description": "Optional. Password (passphrase) for ssh client certificate if it has one." }, "username": { - "description": "The user account used to authenticate.", + "description": "Optional. The user account used to authenticate.", "type": "string" } }, @@ -8148,10 +8895,10 @@ "properties": { "password": { "$ref": "Secret", - "description": "Secret version reference containing the password." + "description": "Optional. Secret version reference containing the password." }, "username": { - "description": "Username.", + "description": "Optional. Username.", "type": "string" } }, diff --git a/discovery/connectors-v2.json b/discovery/connectors-v2.json index 39c7f12f9b..cafb366726 100644 --- a/discovery/connectors-v2.json +++ b/discovery/connectors-v2.json @@ -690,7 +690,7 @@ } } }, - "revision": "20250423", + "revision": "20250507", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -769,6 +769,13 @@ "redirectUri": { "description": "OAuth redirect URI passed in during the auth code flow, required by some OAuth backends.", "type": "string" + }, + "scopes": { + "description": "Scopes the connection will request when the user performs the auth code flow.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index df38bc80be..cdae9fc2f0 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -501,9 +501,342 @@ } }, "authorizedViewSets": { + "methods": { + "create": { + "description": "Create AuthorizedViewSet", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "authorizedViewSetId": { + "description": "Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See go/aip/122#resource-id-segments", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the AuthorizedViewSet.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/authorizedViewSets", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an AuthorizedViewSet.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", + "httpMethod": "DELETE", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all of this AuthorizedViewSet's child resources will also be deleted. Otherwise, the request will only succeed if it has none.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the AuthorizedViewSet to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get AuthorizedViewSet", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AuthorizedViewSet to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List AuthorizedViewSets", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter expression to filter authorized view sets listed in the response.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The order by expression to order authorized view sets listed in the response.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of view sets to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value returned by the last `ListAuthorizedViewSetsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViewSets` call and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the AuthorizedViewSets.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/authorizedViewSets", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an AuthorizedViewSet.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}", + "httpMethod": "PATCH", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "authorizedViews": { "methods": { + "create": { + "description": "Create AuthorizedView", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "authorizedViewId": { + "description": "Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See go/aip/122#resource-id-segments", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the AuthorizedView.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/authorizedViews", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an AuthorizedView.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", + "httpMethod": "DELETE", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AuthorizedView to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get AuthorizedView", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AuthorizedView to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List AuthorizedViewSets", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter expression to filter authorized views listed in the response.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The order by expression to order authorized views listed in the response.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/authorizedViews", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an AuthorizedView.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}", + "httpMethod": "PATCH", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `conversation_filter` * `display_name`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "queryMetrics": { "description": "Query metrics.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}:queryMetrics", @@ -516,17 +849,63 @@ "location": { "description": "Required. The location of the data. \"projects/{project}/locations/{location}\"", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:queryMetrics", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "search": { + "description": "SearchAuthorizedViewSets", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews:search", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "orderBy": { + "description": "Optional. The order by expression to order authorized views listed in the response.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+$", "required": true, "type": "string" + }, + "query": { + "description": "Optional. The query expression to search authorized views.", + "location": "query", + "type": "string" } }, - "path": "v1/{+location}:queryMetrics", - "request": { - "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsRequest" - }, + "path": "v1/{+parent}/authorizedViews:search", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1745,9 +2124,220 @@ } }, "datasets": { + "methods": { + "bulkDeleteFeedbackLabels": { + "description": "Delete feedback labels in bulk using a filter.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDeleteFeedbackLabels", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:bulkDeleteFeedbackLabels", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "bulkDownloadFeedbackLabels": { + "description": "Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkDownloadFeedbackLabels", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:bulkDownloadFeedbackLabels", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "bulkUploadFeedbackLabels": { + "description": "Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:bulkUploadFeedbackLabels", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource for new feedback labels.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:bulkUploadFeedbackLabels", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listAllFeedbackLabels": { + "description": "List all feedback labels by project number.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:listAllFeedbackLabels", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of all feedback labels per project.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:listAllFeedbackLabels", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListAllFeedbackLabelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "conversations": { "methods": { + "bulkAnalyze": { + "description": "Analyzes multiple conversations in a single request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkAnalyze", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.conversations.bulkAnalyze", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource to create analyses in.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/conversations:bulkAnalyze", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "bulkDelete": { + "description": "Deletes multiple conversations in a single request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.conversations.bulkDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/conversations:bulkDelete", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "calculateStats": { + "description": "Gets conversation statistics.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:calculateStats", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.conversations.calculateStats", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The location of the conversations.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}/conversations:calculateStats", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsRequest" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "delete": { "description": "Deletes a conversation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}", @@ -1860,52 +2450,339 @@ "location": "query", "type": "string" }, - "orderBy": { - "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", - "location": "query", - "type": "string" + "orderBy": { + "description": "Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the conversation.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "The level of details of the conversation. Default is `BASIC`.", + "enum": [ + "CONVERSATION_VIEW_UNSPECIFIED", + "FULL", + "BASIC" + ], + "enumDescriptions": [ + "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", + "Populates all fields in the conversation.", + "Populates all fields in the conversation except the transcript." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/conversations", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "analyses": { + "methods": { + "create": { + "description": "Creates an analysis. The long running operation is done when the analysis has completed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the analysis.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/analyses", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1Analysis" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an analysis.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses/{analysesId}", + "httpMethod": "DELETE", + "id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the analysis to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/analyses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an analysis.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses/{analysesId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the analysis to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/analyses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1Analysis" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", - "format": "int32", - "location": "query", - "type": "integer" + "list": { + "description": "Lists analyses.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the analyses.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/analyses", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "feedbackLabels": { + "methods": { + "create": { + "description": "Create feedback label.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "feedbackLabelId": { + "description": "Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the feedback label.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/feedbackLabels", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.", - "location": "query", - "type": "string" + "delete": { + "description": "Delete feedback label.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", + "httpMethod": "DELETE", + "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the feedback label to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "parent": { - "description": "Required. The parent resource of the conversation.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" + "get": { + "description": "Get feedback label.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the feedback label to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "view": { - "description": "The level of details of the conversation. Default is `BASIC`.", - "enum": [ - "CONVERSATION_VIEW_UNSPECIFIED", - "FULL", - "BASIC" + "list": { + "description": "List feedback labels.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.list", + "parameterOrder": [ + "parent" ], - "enumDescriptions": [ - "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", - "Populates all fields in the conversation.", - "Populates all fields in the conversation except the transcript." + "parameters": { + "filter": { + "description": "Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the feedback labels.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/feedbackLabels", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1ListFeedbackLabelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update feedback label.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/feedbackLabels/{feedbackLabelsId}", + "httpMethod": "PATCH", + "id": "contactcenterinsights.projects.locations.datasets.conversations.feedbackLabels.patch", + "parameterOrder": [ + "name" ], - "location": "query", - "type": "string" + "parameters": { + "name": { + "description": "Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/feedbackLabels/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1FeedbackLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1/{+parent}/conversations", - "response": { - "$ref": "GoogleCloudContactcenterinsightsV1ListConversationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } } }, @@ -3377,7 +4254,7 @@ } } }, - "revision": "20250428", + "revision": "20250512", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -3720,12 +4597,70 @@ "description": "The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}", "type": "string" }, - "title": { - "description": "Article title.", + "title": { + "description": "Article title.", + "type": "string" + }, + "uri": { + "description": "Article URI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1AuthorizedView": { + "description": "An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.", + "id": "GoogleCloudContactcenterinsightsV1AuthorizedView", + "properties": { + "conversationFilter": { + "description": "A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations liked to the conversation) that this AuthorizedView has.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which the authorized view was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Display Name. Limit 64 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", + "type": "string" + }, + "updateTime": { + "description": "Output only. The most recent time at which the authorized view was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1AuthorizedViewSet": { + "description": "An AuthorizedViewSet contains a set of AuthorizedView resources.", + "id": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet", + "properties": { + "createTime": { + "description": "Output only. Create time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Display Name. Limit 64 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "type": "string" }, - "uri": { - "description": "Article URI.", + "updateTime": { + "description": "Output only. Update time.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -4160,6 +5095,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1CalculateStatsRequest": { + "description": "The request for calculating conversation statistics.", + "id": "GoogleCloudContactcenterinsightsV1CalculateStatsRequest", + "properties": { + "filter": { + "description": "A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1CalculateStatsResponse": { "description": "The response for calculating conversation statistics.", "id": "GoogleCloudContactcenterinsightsV1CalculateStatsResponse", @@ -4867,6 +5813,56 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1Dataset": { + "description": "Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", + "id": "GoogleCloudContactcenterinsightsV1Dataset", + "properties": { + "createTime": { + "description": "Output only. Dataset create time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Dataset description.", + "type": "string" + }, + "displayName": { + "description": "Display name for the dataaset", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", + "type": "string" + }, + "ttl": { + "description": "Optional. Option TTL for the dataset.", + "format": "google-duration", + "type": "string" + }, + "type": { + "description": "Dataset usage type.", + "enum": [ + "TYPE_UNSPECIFIED", + "EVAL", + "LIVE" + ], + "enumDescriptions": [ + "Default value for unspecified.", + "For evals only.", + "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Dataset update time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata": { "description": "Metadata for deleting an issue model.", "id": "GoogleCloudContactcenterinsightsV1DeleteIssueModelMetadata", @@ -6140,6 +7136,42 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse": { + "description": "The response from a ListAuthorizedViewSet request.", + "id": "GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse", + "properties": { + "authorizedViewSets": { + "description": "The AuthorizedViewSets under the parent.", + "items": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedViewSet" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse": { + "description": "The response from a ListAuthorizedViews request.", + "id": "GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse", + "properties": { + "authorizedViews": { + "description": "The AuthorizedViews under the parent.", + "items": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1ListConversationsResponse": { "description": "The response of listing conversations.", "id": "GoogleCloudContactcenterinsightsV1ListConversationsResponse", @@ -6603,7 +7635,7 @@ "type": "string" }, "tags": { - "description": "User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question.", + "description": "Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question.", "items": { "type": "string" }, @@ -7248,6 +8280,130 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata": { + "description": "The metadata for an SampleConversations operation.", + "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadata", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "partialErrors": { + "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", + "description": "Output only. The original request for sample conversations to dataset.", + "readOnly": true + }, + "sampleConversationsStats": { + "$ref": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", + "description": "Output only. Statistics for SampleConversations operation.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats": { + "description": "Statistics for SampleConversations operation.", + "id": "GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats", + "properties": { + "failedSampleCount": { + "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "successfulSampleCount": { + "description": "Output only. The number of new conversations added during this sample operation.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1SampleConversationsRequest": { + "description": "The request to sample conversations to a dataset.", + "id": "GoogleCloudContactcenterinsightsV1SampleConversationsRequest", + "properties": { + "destinationDataset": { + "$ref": "GoogleCloudContactcenterinsightsV1Dataset", + "description": "The dataset resource to copy the sampled conversations to." + }, + "parent": { + "description": "Required. The parent resource of the dataset.", + "type": "string" + }, + "sampleRule": { + "$ref": "GoogleCloudContactcenterinsightsV1SampleRule", + "description": "Optional. The sample rule used for sampling conversations." + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1SampleConversationsResponse": { + "description": "The response to an SampleConversations operation.", + "id": "GoogleCloudContactcenterinsightsV1SampleConversationsResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1SampleRule": { + "description": "Message for sampling conversations.", + "id": "GoogleCloudContactcenterinsightsV1SampleRule", + "properties": { + "conversationFilter": { + "description": "To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.", + "type": "string" + }, + "dimension": { + "description": "Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'.", + "type": "string" + }, + "samplePercentage": { + "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", + "format": "double", + "type": "number" + }, + "sampleRow": { + "description": "Number of the conversations that we should sample based on the dimension.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse": { + "description": "The response from a ListAuthorizedViews request.", + "id": "GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse", + "properties": { + "authorizedViews": { + "description": "The AuthorizedViews under the parent.", + "items": { + "$ref": "GoogleCloudContactcenterinsightsV1AuthorizedView" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1SentimentData": { "description": "The data for a sentiment annotation.", "id": "GoogleCloudContactcenterinsightsV1SentimentData", @@ -8664,6 +9820,56 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1Dataset": { + "description": "Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)", + "id": "GoogleCloudContactcenterinsightsV1alpha1Dataset", + "properties": { + "createTime": { + "description": "Output only. Dataset create time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Dataset description.", + "type": "string" + }, + "displayName": { + "description": "Display name for the dataaset", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", + "type": "string" + }, + "ttl": { + "description": "Optional. Option TTL for the dataset.", + "format": "google-duration", + "type": "string" + }, + "type": { + "description": "Dataset usage type.", + "enum": [ + "TYPE_UNSPECIFIED", + "EVAL", + "LIVE" + ], + "enumDescriptions": [ + "Default value for unspecified.", + "For evals only.", + "Dataset with new conversations coming in regularly (Insights legacy conversations and AI trainer)" + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Dataset update time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata": { "description": "Metadata for deleting an issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1DeleteIssueModelMetadata", @@ -10440,6 +11646,112 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata": { + "description": "The metadata for an SampleConversations operation.", + "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata", + "properties": { + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "partialErrors": { + "description": "Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest", + "description": "Output only. The original request for sample conversations to dataset.", + "readOnly": true + }, + "sampleConversationsStats": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", + "description": "Output only. Statistics for SampleConversations operation.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats": { + "description": "Statistics for SampleConversations operation.", + "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats", + "properties": { + "failedSampleCount": { + "description": "Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "successfulSampleCount": { + "description": "Output only. The number of new conversations added during this sample operation.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest": { + "description": "The request to sample conversations to a dataset.", + "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest", + "properties": { + "destinationDataset": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1Dataset", + "description": "The dataset resource to copy the sampled conversations to." + }, + "parent": { + "description": "Required. The parent resource of the dataset.", + "type": "string" + }, + "sampleRule": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", + "description": "Optional. The sample rule used for sampling conversations." + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse": { + "description": "The response to an SampleConversations operation.", + "id": "GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1SampleRule": { + "description": "Message for sampling conversations.", + "id": "GoogleCloudContactcenterinsightsV1alpha1SampleRule", + "properties": { + "conversationFilter": { + "description": "To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.", + "type": "string" + }, + "dimension": { + "description": "Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'.", + "type": "string" + }, + "samplePercentage": { + "description": "Percentage of conversations that we should sample based on the dimension between [0, 100].", + "format": "double", + "type": "number" + }, + "sampleRow": { + "description": "Number of the conversations that we should sample based on the dimension.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1SentimentData": { "description": "The data for a sentiment annotation.", "id": "GoogleCloudContactcenterinsightsV1alpha1SentimentData", diff --git a/discovery/container-v1.json b/discovery/container-v1.json index dece0ac20e..331d7433e8 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -2660,7 +2660,7 @@ } } }, - "revision": "20250408", + "revision": "20250506", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3287,6 +3287,13 @@ "$ref": "AddonsConfig", "description": "Configurations for the various addons available to run in the cluster." }, + "alphaClusterFeatureGates": { + "description": "The list of user specified Kubernetes feature gates. Each string represents the activation status of a feature gate (e.g. \"featureX=true\" or \"featureX=false\")", + "items": { + "type": "string" + }, + "type": "array" + }, "authenticatorGroupsConfig": { "$ref": "AuthenticatorGroupsConfig", "description": "Configuration controlling RBAC group membership information." @@ -5501,6 +5508,17 @@ }, "type": "object" }, + "MemoryManager": { + "description": "The option enables the Kubernetes NUMA-aware Memory Manager feature. Detailed description about the feature can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/).", + "id": "MemoryManager", + "properties": { + "policy": { + "description": "Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * \"none\" * \"static\" The default value is 'none' if unspecified.", + "type": "string" + } + }, + "type": "object" + }, "MeshCertificates": { "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.", "id": "MeshCertificates", @@ -6123,10 +6141,18 @@ "description": "Enable or disable Kubelet read only port.", "type": "boolean" }, + "memoryManager": { + "$ref": "MemoryManager", + "description": "Optional. Controls NUMA-aware Memory Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/" + }, "podPidsLimit": { "description": "Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.", "format": "int64", "type": "string" + }, + "topologyManager": { + "$ref": "TopologyManager", + "description": "Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/" } }, "type": "object" @@ -8125,6 +8151,21 @@ }, "type": "object" }, + "TopologyManager": { + "description": "TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/", + "id": "TopologyManager", + "properties": { + "policy": { + "description": "Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).", + "type": "string" + }, + "scope": { + "description": "The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes", + "type": "string" + } + }, + "type": "object" + }, "UpdateClusterRequest": { "description": "UpdateClusterRequest updates the settings of a cluster.", "id": "UpdateClusterRequest", diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index 34ef5079b5..cfd0b232c2 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2685,7 +2685,7 @@ } } }, - "revision": "20250408", + "revision": "20250506", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3392,6 +3392,13 @@ "$ref": "AddonsConfig", "description": "Configurations for the various addons available to run in the cluster." }, + "alphaClusterFeatureGates": { + "description": "The list of user specified Kubernetes feature gates. Each string represents the activation status of a feature gate (e.g. \"featureX=true\" or \"featureX=false\")", + "items": { + "type": "string" + }, + "type": "array" + }, "authenticatorGroupsConfig": { "$ref": "AuthenticatorGroupsConfig", "description": "Configuration controlling RBAC group membership information." @@ -5861,6 +5868,17 @@ }, "type": "object" }, + "MemoryManager": { + "description": "The option enables the Kubernetes NUMA-aware Memory Manager feature. Detailed description about the feature can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/).", + "id": "MemoryManager", + "properties": { + "policy": { + "description": "Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * \"none\" * \"static\" The default value is 'none' if unspecified.", + "type": "string" + } + }, + "type": "object" + }, "MeshCertificates": { "description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.", "id": "MeshCertificates", @@ -6527,10 +6545,18 @@ "description": "Enable or disable Kubelet read only port.", "type": "boolean" }, + "memoryManager": { + "$ref": "MemoryManager", + "description": "Optional. Controls NUMA-aware Memory Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/" + }, "podPidsLimit": { "description": "Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.", "format": "int64", "type": "string" + }, + "topologyManager": { + "$ref": "TopologyManager", + "description": "Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/" } }, "type": "object" @@ -8638,6 +8664,21 @@ }, "type": "object" }, + "TopologyManager": { + "description": "TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/", + "id": "TopologyManager", + "properties": { + "policy": { + "description": "Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies).", + "type": "string" + }, + "scope": { + "description": "The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes", + "type": "string" + } + }, + "type": "object" + }, "TpuConfig": { "deprecated": true, "description": "Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.", diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index 8eca63f7f6..f22b3c30b7 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -1685,7 +1685,7 @@ } } }, - "revision": "20250425", + "revision": "20250509", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -4413,7 +4413,8 @@ "COMPLIANCE", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -4428,7 +4429,8 @@ "This represents a Compliance Note", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", - "This represents an SBOM Reference." + "This represents an SBOM Reference.", + "This represents a secret." ], "type": "string" } @@ -5157,6 +5159,10 @@ }, "type": "array" }, + "chainId": { + "description": "The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid", + "type": "string" + }, "command": { "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", "type": "string" @@ -5381,7 +5387,8 @@ "COMPLIANCE", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -5396,7 +5403,8 @@ "This represents a Compliance Note", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", - "This represents an SBOM Reference." + "This represents an SBOM Reference.", + "This represents a secret." ], "type": "string" }, @@ -5430,6 +5438,10 @@ "$ref": "SBOMReferenceNote", "description": "A note describing an SBOM reference." }, + "secret": { + "$ref": "SecretNote", + "description": "A note describing a secret." + }, "shortDescription": { "description": "A one sentence description of this note.", "type": "string" @@ -5510,7 +5522,8 @@ "COMPLIANCE", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -5525,7 +5538,8 @@ "This represents a Compliance Note", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", - "This represents an SBOM Reference." + "This represents an SBOM Reference.", + "This represents a secret." ], "type": "string" }, @@ -5553,6 +5567,10 @@ "$ref": "SBOMReferenceOccurrence", "description": "Describes a specific SBOM reference occurrences." }, + "secret": { + "$ref": "SecretOccurrence", + "description": "Describes a secret." + }, "updateTime": { "description": "Output only. The time this occurrence was last updated.", "format": "google-datetime", @@ -6127,6 +6145,90 @@ }, "type": "object" }, + "SecretLocation": { + "description": "The location of the secret.", + "id": "SecretLocation", + "properties": { + "fileLocation": { + "$ref": "GrafeasV1FileLocation", + "description": "The secret is found from a file." + } + }, + "type": "object" + }, + "SecretNote": { + "description": "The note representing a secret.", + "id": "SecretNote", + "properties": {}, + "type": "object" + }, + "SecretOccurrence": { + "description": "The occurrence provides details of a secret.", + "id": "SecretOccurrence", + "properties": { + "kind": { + "description": "Required. Type of secret.", + "enum": [ + "SECRET_KIND_UNSPECIFIED", + "SECRET_KIND_UNKNOWN", + "SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY" + ], + "enumDescriptions": [ + "Unspecified", + "The secret kind is unknown.", + "A GCP service account key per: https://cloud.google.com/iam/docs/creating-managing-service-account-keys" + ], + "type": "string" + }, + "locations": { + "description": "Optional. Locations where the secret is detected.", + "items": { + "$ref": "SecretLocation" + }, + "type": "array" + }, + "statuses": { + "description": "Optional. Status of the secret.", + "items": { + "$ref": "SecretStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretStatus": { + "description": "The status of the secret with a timestamp.", + "id": "SecretStatus", + "properties": { + "message": { + "description": "Optional. Optional message about the status code.", + "type": "string" + }, + "status": { + "description": "Optional. The status of the secret.", + "enum": [ + "STATUS_UNSPECIFIED", + "UNKNOWN", + "VALID", + "INVALID" + ], + "enumDescriptions": [ + "Unspecified", + "The status of the secret is unknown.", + "The secret is valid.", + "The secret is invalid." + ], + "type": "string" + }, + "updateTime": { + "description": "Optional. The time the secret status was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index c1b0bf5186..1716681aeb 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -828,7 +828,8 @@ "SPDX_RELATIONSHIP", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Unknown", @@ -847,7 +848,8 @@ "This represents an SPDX Relationship.", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", - "This represents a reference to an SBOM." + "This represents a reference to an SBOM.", + "This represents a secret." ], "location": "query", "type": "string" @@ -1450,7 +1452,7 @@ } } }, - "revision": "20250425", + "revision": "20250509", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -4104,7 +4106,8 @@ "SPDX_RELATIONSHIP", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Unknown", @@ -4123,7 +4126,8 @@ "This represents an SPDX Relationship.", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", - "This represents a reference to an SBOM." + "This represents a reference to an SBOM.", + "This represents a secret." ], "type": "string" } @@ -5338,7 +5342,8 @@ "SPDX_RELATIONSHIP", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Unknown", @@ -5357,7 +5362,8 @@ "This represents an SPDX Relationship.", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", - "This represents a reference to an SBOM." + "This represents a reference to an SBOM.", + "This represents a secret." ], "type": "string" }, @@ -5388,6 +5394,10 @@ "$ref": "SBOMReferenceNote", "description": "A note describing a reference to an SBOM." }, + "secret": { + "$ref": "SecretNote", + "description": "A note describing a secret." + }, "shortDescription": { "description": "A one sentence description of this `Note`.", "type": "string" @@ -5488,7 +5498,8 @@ "SPDX_RELATIONSHIP", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Unknown", @@ -5507,7 +5518,8 @@ "This represents an SPDX Relationship.", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", - "This represents a reference to an SBOM." + "This represents a reference to an SBOM.", + "This represents a secret." ], "type": "string" }, @@ -5539,6 +5551,10 @@ "$ref": "SBOMReferenceOccurrence", "description": "This represents an SBOM reference occurrence" }, + "secret": { + "$ref": "SecretOccurrence", + "description": "This represents a secret occurrence" + }, "spdxFile": { "$ref": "FileOccurrence", "description": "Describes a specific SPDX File." @@ -6510,6 +6526,90 @@ }, "type": "object" }, + "SecretLocation": { + "description": "The location of the secret.", + "id": "SecretLocation", + "properties": { + "fileLocation": { + "$ref": "FileLocation", + "description": "The secret is found from a file." + } + }, + "type": "object" + }, + "SecretNote": { + "description": "The note representing a secret.", + "id": "SecretNote", + "properties": {}, + "type": "object" + }, + "SecretOccurrence": { + "description": "The occurrence provides details of a secret.", + "id": "SecretOccurrence", + "properties": { + "kind": { + "description": "Required. Type of secret.", + "enum": [ + "SECRET_KIND_UNSPECIFIED", + "SECRET_KIND_UNKNOWN", + "SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY" + ], + "enumDescriptions": [ + "Unspecified", + "The secret kind is unknown.", + "A GCP service account key per: https://cloud.google.com/iam/docs/creating-managing-service-account-keys" + ], + "type": "string" + }, + "locations": { + "description": "Optional. Locations where the secret is detected.", + "items": { + "$ref": "SecretLocation" + }, + "type": "array" + }, + "statuses": { + "description": "Optional. Status of the secret.", + "items": { + "$ref": "SecretStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretStatus": { + "description": "The status of the secret with a timestamp.", + "id": "SecretStatus", + "properties": { + "message": { + "description": "Optional. Optional message about the status code.", + "type": "string" + }, + "status": { + "description": "Optional. The status of the secret.", + "enum": [ + "STATUS_UNSPECIFIED", + "UNKNOWN", + "VALID", + "INVALID" + ], + "enumDescriptions": [ + "Unspecified", + "The status of the secret is unknown.", + "The secret is valid.", + "The secret is invalid." + ], + "type": "string" + }, + "updateTime": { + "description": "Optional. The time the secret status was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/discovery/datacatalog-v1.json b/discovery/datacatalog-v1.json index e0b82e385d..c9dbb5866f 100644 --- a/discovery/datacatalog-v1.json +++ b/discovery/datacatalog-v1.json @@ -2339,7 +2339,7 @@ } } }, - "revision": "20250429", + "revision": "20250502", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -3365,7 +3365,7 @@ "id": "GoogleCloudDatacatalogV1GcsFilesetSpec", "properties": { "filePatterns": { - "description": "Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g`", + "description": "Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/wildcards). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g`", "items": { "type": "string" }, diff --git a/discovery/datacatalog-v1beta1.json b/discovery/datacatalog-v1beta1.json index fc63d84a9c..12eed01ce8 100644 --- a/discovery/datacatalog-v1beta1.json +++ b/discovery/datacatalog-v1beta1.json @@ -1855,7 +1855,7 @@ } } }, - "revision": "20250314", + "revision": "20250502", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2775,7 +2775,7 @@ "id": "GoogleCloudDatacatalogV1GcsFilesetSpec", "properties": { "filePatterns": { - "description": "Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g`", + "description": "Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/wildcards). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g`", "items": { "type": "string" }, @@ -3809,7 +3809,7 @@ "id": "GoogleCloudDatacatalogV1beta1GcsFilesetSpec", "properties": { "filePatterns": { - "description": "Required. Patterns to identify a set of files in Google Cloud Storage. See [Cloud Storage documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames) for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * `gs://bucket_name/dir/*`: matches all files within `bucket_name/dir` directory. * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` spanning all subdirectories. * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to provide more powerful matches, for example: * `gs://bucket_name/[a-m]??.j*g`", + "description": "Required. Patterns to identify a set of files in Google Cloud Storage. See [Cloud Storage documentation](https://cloud.google.com/storage/docs/wildcards) for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * `gs://bucket_name/dir/*`: matches all files within `bucket_name/dir` directory. * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` spanning all subdirectories. * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to provide more powerful matches, for example: * `gs://bucket_name/[a-m]??.j*g`", "items": { "type": "string" }, diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index af4ebcce13..3550433e1e 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -2208,7 +2208,7 @@ } } }, - "revision": "20250428", + "revision": "20250505", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -3306,6 +3306,10 @@ "description": "The prefix of the resources the system should use for temporary storage. The system will append the suffix \"/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}", "type": "string" }, + "usePublicIps": { + "description": "Optional. True when any worker pool that uses public IPs is present.", + "type": "boolean" + }, "useStreamingEngineResourceBasedBilling": { "description": "Output only. Whether the job uses the Streaming Engine resource-based billing model.", "readOnly": true, diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index ec60a5b088..3363527474 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -2340,7 +2340,7 @@ } } }, - "revision": "20250416", + "revision": "20250507", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -3212,6 +3212,26 @@ "$ref": "DatabaseEngineInfo", "description": "Required. The destination engine details." }, + "destinationProvider": { + "description": "Optional. The provider for the destination database.", + "enum": [ + "DATABASE_PROVIDER_UNSPECIFIED", + "CLOUDSQL", + "RDS", + "AURORA", + "ALLOYDB", + "AZURE_DATABASE" + ], + "enumDescriptions": [ + "Use this value for on-premise source database instances and ORACLE.", + "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.", + "Microsoft Azure Database for MySQL/PostgreSQL." + ], + "type": "string" + }, "displayName": { "description": "Optional. The display name for the workspace.", "type": "string" @@ -3247,6 +3267,26 @@ "$ref": "DatabaseEngineInfo", "description": "Required. The source engine details." }, + "sourceProvider": { + "description": "Optional. The provider for the source database.", + "enum": [ + "DATABASE_PROVIDER_UNSPECIFIED", + "CLOUDSQL", + "RDS", + "AURORA", + "ALLOYDB", + "AZURE_DATABASE" + ], + "enumDescriptions": [ + "Use this value for on-premise source database instances and ORACLE.", + "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.", + "Microsoft Azure Database for MySQL/PostgreSQL." + ], + "type": "string" + }, "updateTime": { "description": "Output only. The timestamp when the workspace resource was last updated.", "format": "google-datetime", diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index 476bf409a5..f11d41f909 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -879,7 +879,7 @@ ], "parameters": { "name": { - "description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.", + "description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/global.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2968,7 +2968,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.", + "description": "Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "required": true, @@ -2996,7 +2996,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Entry Link: projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.", + "description": "Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entryLinks/[^/]+$", "required": true, @@ -3012,7 +3012,7 @@ ] }, "get": { - "description": "Gets an entry link.", + "description": "Gets an Entry Link.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entryLinks/{entryLinksId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.entryLinks.get", @@ -3021,7 +3021,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Entry Link: projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.", + "description": "Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entryLinks/[^/]+$", "required": true, @@ -7027,7 +7027,7 @@ } } }, - "revision": "20250429", + "revision": "20250513", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -10467,7 +10467,7 @@ "type": "object" }, "GoogleCloudDataplexV1EntryLink": { - "description": "EntryLink represents a link between two entries.", + "description": "EntryLink represents a link between two Entries.", "id": "GoogleCloudDataplexV1EntryLink", "properties": { "createTime": { @@ -10477,18 +10477,18 @@ "type": "string" }, "entryLinkType": { - "description": "Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link, of the form: projects/{project}/locations/{location}/entryLinkTypes/{entry_link_type}.", + "description": "Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link, of the form: `projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}.", "type": "string" }, "entryReferences": { - "description": "Required. Specifies the entries referenced in the entry link. There should be exactly two entry references.", + "description": "Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.", "items": { "$ref": "GoogleCloudDataplexV1EntryLinkEntryReference" }, "type": "array" }, "name": { - "description": "Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entryLinks/{entry_link}.", + "description": "Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}", "readOnly": true, "type": "string" }, @@ -10502,28 +10502,28 @@ "type": "object" }, "GoogleCloudDataplexV1EntryLinkEntryReference": { - "description": "Reference to the Entry that is linked through the entry link.", + "description": "Reference to the Entry that is linked through the Entry Link.", "id": "GoogleCloudDataplexV1EntryLinkEntryReference", "properties": { "name": { - "description": "Required. Immutable. The relative resource name of the referenced entry, of the form: projects/{project}/locations/{location}/entryGroups/{entryGroup}/entries/{entry}.", + "description": "Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}", "type": "string" }, "path": { - "description": "Immutable. The path in the entry that is referenced in the entry link. Empty path denotes that the entry itself is referenced in the entry link.", + "description": "Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.", "type": "string" }, "type": { - "description": "Required. Immutable. The reference type of the entry.", + "description": "Required. Immutable. The reference type of the Entry.", "enum": [ "UNSPECIFIED", "SOURCE", "TARGET" ], "enumDescriptions": [ - "Unspecified reference type. Implies that the entry is referenced in a non-directional entry link.", - "The entry is referenced as the source of the directional entry link.", - "The entry is referenced as the target of the directional entry link." + "Unspecified reference type. Implies that the Entry is referenced in a non-directional Entry Link.", + "The Entry is referenced as the source of the directional Entry Link.", + "The Entry is referenced as the target of the directional Entry Link." ], "type": "string" } diff --git a/discovery/datastream-v1.json b/discovery/datastream-v1.json index 6d7272ae21..69da2cac47 100644 --- a/discovery/datastream-v1.json +++ b/discovery/datastream-v1.json @@ -1261,7 +1261,7 @@ } } }, - "revision": "20250321", + "revision": "20250511", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -2209,7 +2209,7 @@ "id": "MongodbProfile", "properties": { "hostAddresses": { - "description": "Required. List of host addresses for a MongoDB cluster.", + "description": "Required. List of host addresses for a MongoDB cluster. For SRV connection format, this list must contain exactly one DNS host without a port. For Standard connection format, this list must contain all the required hosts in the cluster with their respective ports.", "items": { "$ref": "HostAddress" }, @@ -2220,7 +2220,7 @@ "type": "string" }, "replicaSet": { - "description": "Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster.", + "description": "Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster. For SRV connection format, this field must be empty. For Standard connection format, this field must be specified.", "type": "string" }, "secretManagerStoredPassword": { @@ -2253,6 +2253,11 @@ "includeObjects": { "$ref": "MongodbCluster", "description": "MongoDB collections to include in the stream." + }, + "maxConcurrentBackfillTasks": { + "description": "Optional. Maximum number of concurrent backfill tasks. The number should be non-negative and less than or equal to 50. If not set (or set to 0), the system's default value is used", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -3681,7 +3686,12 @@ "StandardConnectionFormat": { "description": "Standard connection format.", "id": "StandardConnectionFormat", - "properties": {}, + "properties": { + "directConnection": { + "description": "Optional. Specifies whether the client connects directly to the host[:port] in the connection URI.", + "type": "boolean" + } + }, "type": "object" }, "StartBackfillJobRequest": { diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json index 5f6031da2c..fcbd019826 100644 --- a/discovery/developerconnect-v1.json +++ b/discovery/developerconnect-v1.json @@ -1405,7 +1405,7 @@ } } }, - "revision": "20250414", + "revision": "20250502", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -2447,7 +2447,8 @@ "SENTRY", "ROVO", "NEW_RELIC", - "DATASTAX" + "DATASTAX", + "DYNATRACE" ], "enumDescriptions": [ "No system provider specified.", @@ -2457,7 +2458,8 @@ "Sentry provider. Scopes can be found at https://docs.sentry.io/api/permissions/", "Rovo provider. Must select the \"rovo\" scope.", "New Relic provider. No scopes are allowed.", - "Datastax provider. No scopes are allowed." + "Datastax provider. No scopes are allowed.", + "Dynatrace provider." ], "type": "string" } diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 1fa13b6e58..7b104502e6 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -8805,7 +8805,7 @@ } } }, - "revision": "20250422", + "revision": "20250508", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -15924,6 +15924,10 @@ "description": "The resource name of the existing created generator. Format: `projects//locations//generators/`", "type": "string" }, + "securitySettings": { + "description": "Optional. Name of the CX SecuritySettings which is used to redact generated response. If this field is empty, try to fetch v2 security_settings, which is a project level setting. If this field is empty and no v2 security_settings set up in this project, no redaction will be done. Format: `projects//locations//securitySettings/`.", + "type": "string" + }, "triggerEvents": { "description": "Optional. A list of trigger events. Generator will be triggered only if it's trigger event is included here.", "items": { diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index 780d262b3a..d891078913 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -8602,7 +8602,7 @@ } } }, - "revision": "20250422", + "revision": "20250508", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -18161,6 +18161,10 @@ "description": "The resource name of the existing created generator. Format: `projects//locations//generators/`", "type": "string" }, + "securitySettings": { + "description": "Optional. Name of the CX SecuritySettings which is used to redact generated response. If this field is empty, try to fetch v2 security_settings, which is a project level setting. If this field is empty and no v2 security_settings set up in this project, no redaction will be done. Format: `projects//locations//securitySettings/`.", + "type": "string" + }, "triggerEvents": { "description": "Optional. A list of trigger events. Generator will be triggered only if it's trigger event is included here.", "items": { diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index d83a98f26e..f3298c2c08 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -635,7 +635,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -3127,7 +3127,7 @@ ], "parameters": { "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -4279,7 +4279,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -6869,6 +6869,85 @@ ] } } + }, + "userStores": { + "methods": { + "batchUpdateUserLicenses": { + "description": "Updates the User License. This method is used for batch assign/unassign licenses to users.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}:batchUpdateUserLicenses", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userStores.batchUpdateUserLicenses", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:batchUpdateUserLicenses", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "userLicenses": { + "methods": { + "list": { + "description": "Lists the User Licenses.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userStores.userLicenses.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/userLicenses", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListUserLicensesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } }, @@ -6973,7 +7052,7 @@ } } }, - "revision": "20250425", + "revision": "20250519", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -7453,7 +7532,8 @@ "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", "LOW_GROUNDED_ANSWER", - "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED", + "UNHELPFUL_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -7466,7 +7546,8 @@ "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", "The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", - "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification.", + "The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted." ], "type": "string" }, @@ -8741,6 +8822,44 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest": { + "description": "Request message for UserLicenseService.BatchUpdateUserLicenses method.", + "id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest", + "properties": { + "deleteUnassignedUserLicenses": { + "description": "Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state.", + "type": "boolean" + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1GcsSource", + "description": "Cloud Storage location for the input content." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource", + "description": "The inline source for the input content for document embeddings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource": { + "description": "The inline source for the input config for BatchUpdateUserLicenses method.", + "id": "GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource", + "properties": { + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "type": "string" + }, + "userLicenses": { + "description": "Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1UserLicense" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest": { "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", "id": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest", @@ -9028,7 +9147,7 @@ "type": "boolean" }, "score": { - "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true.", + "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.", "format": "double", "type": "number" }, @@ -9068,6 +9187,14 @@ "readOnly": true, "type": "array" }, + "annotationMetadata": { + "description": "Output only. The annotation metadata includes structured content in the current chunk.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata" + }, + "readOnly": true, + "type": "array" + }, "chunkMetadata": { "$ref": "GoogleCloudDiscoveryengineV1ChunkChunkMetadata", "description": "Output only. Metadata of the current chunk.", @@ -9119,6 +9246,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata": { + "description": "The annotation metadata includes structured content in the current chunk.", + "id": "GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata", + "properties": { + "imageId": { + "description": "Output only. Image id is provided if the structured content is based on an image.", + "readOnly": true, + "type": "string" + }, + "structuredContent": { + "$ref": "GoogleCloudDiscoveryengineV1ChunkStructuredContent", + "description": "Output only. The structured content information.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ChunkChunkMetadata": { "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", "id": "GoogleCloudDiscoveryengineV1ChunkChunkMetadata", @@ -9180,6 +9324,35 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ChunkStructuredContent": { + "description": "The structured content information.", + "id": "GoogleCloudDiscoveryengineV1ChunkStructuredContent", + "properties": { + "content": { + "description": "Output only. The content of the structured content.", + "readOnly": true, + "type": "string" + }, + "structureType": { + "description": "Output only. The structure type of the structured content.", + "enum": [ + "STRUCTURE_TYPE_UNSPECIFIED", + "SHAREHOLDER_STRUCTURE", + "SIGNATURE_STRUCTURE", + "CHECKBOX_STRUCTURE" + ], + "enumDescriptions": [ + "Default value.", + "Shareholder structure.", + "Signature structure.", + "Checkbox structure." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1CloudSqlSource": { "description": "Cloud SQL source import data from.", "id": "GoogleCloudDiscoveryengineV1CloudSqlSource", @@ -9477,7 +9650,7 @@ }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "description": "Promote certain links based on predefined trigger queries." }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", @@ -10102,7 +10275,7 @@ "type": "string" }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "servingConfigDataStore": { @@ -10183,7 +10356,7 @@ "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", "properties": { "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", + "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, @@ -10717,7 +10890,7 @@ "type": "string" }, "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, @@ -10732,7 +10905,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -10752,7 +10925,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "searchEngineConfig": { @@ -11901,6 +12074,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ListUserLicensesResponse": { + "description": "Response message for UserLicenseService.ListUserLicenses.", + "id": "GoogleCloudDiscoveryengineV1ListUserLicensesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "userLicenses": { + "description": "All the customer's UserLicenses.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1UserLicense" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1MediaInfo": { "description": "Media-specific user event information.", "id": "GoogleCloudDiscoveryengineV1MediaInfo", @@ -13109,6 +13300,10 @@ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec", "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, + "customSearchOperators": { + "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", + "type": "string" + }, "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" @@ -14476,6 +14671,66 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1UserLicense": { + "description": "User License information assigned by the admin.", + "id": "GoogleCloudDiscoveryengineV1UserLicense", + "properties": { + "createTime": { + "description": "Output only. User created timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "lastLoginTime": { + "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "licenseAssignmentState": { + "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;", + "enum": [ + "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED", + "ASSIGNED", + "UNASSIGNED", + "NO_LICENSE", + "NO_LICENSE_ATTEMPTED_LOGIN" + ], + "enumDescriptions": [ + "Default value.", + "License assigned to the user.", + "No license assigned to the user. Deprecated, translated to NO_LICENSE.", + "No license assigned to the user.", + "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." + ], + "readOnly": true, + "type": "string" + }, + "licenseConfig": { + "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", + "type": "string" + }, + "updateTime": { + "description": "Output only. User update timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "user": { + "description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.", + "type": "string" + }, + "userPrincipal": { + "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.", + "type": "string" + }, + "userProfile": { + "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", @@ -14636,7 +14891,8 @@ "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", "LOW_GROUNDED_ANSWER", - "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED", + "UNHELPFUL_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -14649,7 +14905,8 @@ "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", "The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", - "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification.", + "The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted." ], "type": "string" }, @@ -15250,12 +15507,14 @@ "enum": [ "CONNECTOR_MODE_UNSPECIFIED", "DATA_INGESTION", - "ACTIONS" + "ACTIONS", + "END_USER_AUTHENTICATION" ], "enumDescriptions": [ "Connector mode unspecified.", "Connector utilized for data ingestion.", - "Connector utilized for Actions" + "Connector utilized for Actions", + "Connector utilized for End User Authentication." ], "type": "string" }, @@ -15295,6 +15554,54 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata": { + "description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of user licenses that failed to be updated.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of user licenses successfully updated.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse": { + "description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "userLicenses": { + "description": "UserLicenses successfully updated.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCmekConfig": { "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", @@ -15639,13 +15946,15 @@ "SYNC_TYPE_UNSPECIFIED", "FULL", "INCREMENTAL", - "REALTIME" + "REALTIME", + "SCALA_SYNC" ], "enumDescriptions": [ "Sync type unspecified.", "Sync triggers full sync of all documents.", "Incremental sync of updated documents.", - "Realtime sync." + "Realtime sync.", + "Scala sync." ], "type": "string" } @@ -15711,7 +16020,7 @@ }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "description": "Promote certain links based on predefined trigger queries." }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", @@ -16037,7 +16346,7 @@ "type": "array" }, "autoRunDisabled": { - "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.", + "description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs", "type": "boolean" }, "bapConfig": { @@ -16084,7 +16393,7 @@ "type": "array" }, "connectorType": { - "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system.", + "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ "CONNECTOR_TYPE_UNSPECIFIED", "THIRD_PARTY", @@ -16114,6 +16423,10 @@ "readOnly": true, "type": "string" }, + "createEuaSaas": { + "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.", + "type": "boolean" + }, "createTime": { "description": "Output only. Timestamp the DataConnector was created at.", "format": "google-datetime", @@ -16160,6 +16473,15 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." }, + "incrementalRefreshInterval": { + "description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days.", + "format": "google-duration", + "type": "string" + }, + "incrementalSyncDisabled": { + "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled.", + "type": "boolean" + }, "kmsKeyName": { "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", "type": "string" @@ -16270,12 +16592,14 @@ "enum": [ "PERIODIC", "STREAMING", - "UNSPECIFIED" + "UNSPECIFIED", + "SCALA_SYNC" ], "enumDescriptions": [ "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", "The data will be synced in real time.", - "Connector that doesn't ingest data will have this value" + "Connector that doesn't ingest data will have this value", + "The data will be synced with Scala Sync, a data ingestion solution." ], "type": "string" }, @@ -16466,7 +16790,7 @@ "description": "Language info for DataStore." }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "naturalLanguageQueryUnderstandingConfig": { @@ -16551,7 +16875,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "properties": { "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", + "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, @@ -16972,7 +17296,7 @@ "type": "string" }, "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, @@ -16987,7 +17311,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -17007,7 +17331,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "recommendationMetadata": { @@ -19260,6 +19584,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, + "customSearchOperators": { + "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", + "type": "string" + }, "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" @@ -20039,6 +20367,66 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaUserLicense": { + "description": "User License information assigned by the admin.", + "id": "GoogleCloudDiscoveryengineV1alphaUserLicense", + "properties": { + "createTime": { + "description": "Output only. User created timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "lastLoginTime": { + "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "licenseAssignmentState": { + "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;", + "enum": [ + "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED", + "ASSIGNED", + "UNASSIGNED", + "NO_LICENSE", + "NO_LICENSE_ATTEMPTED_LOGIN" + ], + "enumDescriptions": [ + "Default value.", + "License assigned to the user.", + "No license assigned to the user. Deprecated, translated to NO_LICENSE.", + "No license assigned to the user.", + "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." + ], + "readOnly": true, + "type": "string" + }, + "licenseConfig": { + "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", + "type": "string" + }, + "updateTime": { + "description": "Output only. User update timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "user": { + "description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.", + "type": "string" + }, + "userPrincipal": { + "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.", + "type": "string" + }, + "userProfile": { + "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", @@ -20303,7 +20691,7 @@ }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "description": "Promote certain links based on predefined trigger queries." }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", @@ -20694,7 +21082,7 @@ "description": "Language info for DataStore." }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "naturalLanguageQueryUnderstandingConfig": { @@ -20779,7 +21167,7 @@ "id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", "properties": { "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", + "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, @@ -21113,7 +21501,7 @@ "type": "string" }, "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, @@ -21128,7 +21516,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -21148,7 +21536,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "searchEngineConfig": { @@ -22698,6 +23086,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, + "customSearchOperators": { + "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", + "type": "string" + }, "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index 2b47f5d894..0cc90ff6d3 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -1234,7 +1234,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1488,13 +1488,15 @@ "PROCESSED_DOCUMENT_TYPE_UNSPECIFIED", "PARSED_DOCUMENT", "CHUNKED_DOCUMENT", - "IMAGE_CONVERTED_DOCUMENT" + "IMAGE_CONVERTED_DOCUMENT", + "IMAGE_BYTES" ], "enumDescriptions": [ "Default value.", "Available for all data store parsing configs.", "Only available if ChunkingConfig is enabled on the data store.", - "Returns the converted Image bytes (as JPEG or PNG) if available." + "Returns the converted Image bytes (as JPEG or PNG) if available.", + "Return image bytes in base64 encoded format if image_id of a document is provided, only supported for enabling shareholder-structure in layout parsing config for now." ], "location": "query", "type": "string" @@ -4068,7 +4070,7 @@ ], "parameters": { "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -5457,7 +5459,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5683,13 +5685,15 @@ "PROCESSED_DOCUMENT_TYPE_UNSPECIFIED", "PARSED_DOCUMENT", "CHUNKED_DOCUMENT", - "IMAGE_CONVERTED_DOCUMENT" + "IMAGE_CONVERTED_DOCUMENT", + "IMAGE_BYTES" ], "enumDescriptions": [ "Default value.", "Available for all data store parsing configs.", "Only available if ChunkingConfig is enabled on the data store.", - "Returns the converted Image bytes (as JPEG or PNG) if available." + "Returns the converted Image bytes (as JPEG or PNG) if available.", + "Return image bytes in base64 encoded format if image_id of a document is provided, only supported for enabling shareholder-structure in layout parsing config for now." ], "location": "query", "type": "string" @@ -8256,6 +8260,49 @@ } } }, + "notebooks": { + "resources": { + "sources": { + "methods": { + "uploadFile": { + "description": "Uploads a file for Notebook LM to use. Creates a Source.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources/{sourceId}:uploadFile", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.notebooks.sources.uploadFile", + "parameterOrder": [ + "parent", + "sourceId" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", + "required": true, + "type": "string" + }, + "sourceId": { + "description": "The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sources/{sourceId}:uploadFile", + "request": { + "$ref": "GoogleCloudNotebooklmV1alphaUploadSourceFileRequest" + }, + "response": { + "$ref": "GoogleCloudNotebooklmV1alphaUploadSourceFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -8903,6 +8950,36 @@ } }, "userStores": { + "methods": { + "batchUpdateUserLicenses": { + "description": "Updates the User License. This method is used for batch assign/unassign licenses to users.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}:batchUpdateUserLicenses", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userStores.batchUpdateUserLicenses", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:batchUpdateUserLicenses", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -8973,6 +9050,51 @@ ] } } + }, + "userLicenses": { + "methods": { + "list": { + "description": "Lists the User Licenses.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userStores.userLicenses.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLicenses", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } @@ -9051,7 +9173,7 @@ } } }, - "revision": "20250425", + "revision": "20250519", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -10332,7 +10454,7 @@ }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "description": "Promote certain links based on predefined trigger queries." }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", @@ -10702,7 +10824,7 @@ "type": "string" }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "servingConfigDataStore": { @@ -10783,7 +10905,7 @@ "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", "properties": { "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", + "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, @@ -11111,7 +11233,7 @@ "type": "string" }, "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, @@ -11126,7 +11248,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -11146,7 +11268,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "searchEngineConfig": { @@ -13002,7 +13124,8 @@ "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", "LOW_GROUNDED_ANSWER", - "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED", + "UNHELPFUL_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -13015,7 +13138,8 @@ "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", "The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", - "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification.", + "The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted." ], "type": "string" }, @@ -14295,12 +14419,14 @@ "enum": [ "CONNECTOR_MODE_UNSPECIFIED", "DATA_INGESTION", - "ACTIONS" + "ACTIONS", + "END_USER_AUTHENTICATION" ], "enumDescriptions": [ "Connector mode unspecified.", "Connector utilized for data ingestion.", - "Connector utilized for Actions" + "Connector utilized for Actions", + "Connector utilized for End User Authentication." ], "type": "string" }, @@ -14419,6 +14545,92 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata": { + "description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of user licenses that failed to be updated.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of user licenses successfully updated.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest": { + "description": "Request message for UserLicenseService.BatchUpdateUserLicenses method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest", + "properties": { + "deleteUnassignedUserLicenses": { + "description": "Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state.", + "type": "boolean" + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource", + "description": "The inline source for the input content for document embeddings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource": { + "description": "The inline source for the input config for BatchUpdateUserLicenses method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource", + "properties": { + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "type": "string" + }, + "userLicenses": { + "description": "Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse": { + "description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "userLicenses": { + "description": "UserLicenses successfully updated.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": { "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", "id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest", @@ -14706,7 +14918,7 @@ "type": "boolean" }, "score": { - "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true.", + "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.", "format": "double", "type": "number" }, @@ -14823,6 +15035,14 @@ "readOnly": true, "type": "array" }, + "annotationMetadata": { + "description": "Output only. The annotation metadata includes structured content in the current chunk.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata" + }, + "readOnly": true, + "type": "array" + }, "chunkMetadata": { "$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", "description": "Output only. Metadata of the current chunk.", @@ -14874,6 +15094,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata": { + "description": "The annotation metadata includes structured content in the current chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata", + "properties": { + "imageId": { + "description": "Output only. Image id is provided if the structured content is based on an image.", + "readOnly": true, + "type": "string" + }, + "structuredContent": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkStructuredContent", + "description": "Output only. The structured content information.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": { "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", "id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", @@ -14935,6 +15172,35 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaChunkStructuredContent": { + "description": "The structured content information.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkStructuredContent", + "properties": { + "content": { + "description": "Output only. The content of the structured content.", + "readOnly": true, + "type": "string" + }, + "structureType": { + "description": "Output only. The structure type of the structured content.", + "enum": [ + "STRUCTURE_TYPE_UNSPECIFIED", + "SHAREHOLDER_STRUCTURE", + "SIGNATURE_STRUCTURE", + "CHECKBOX_STRUCTURE" + ], + "enumDescriptions": [ + "Default value.", + "Shareholder structure.", + "Signature structure.", + "Checkbox structure." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": { "description": "Cloud SQL source import data from.", "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", @@ -15403,13 +15669,15 @@ "SYNC_TYPE_UNSPECIFIED", "FULL", "INCREMENTAL", - "REALTIME" + "REALTIME", + "SCALA_SYNC" ], "enumDescriptions": [ "Sync type unspecified.", "Sync triggers full sync of all documents.", "Incremental sync of updated documents.", - "Realtime sync." + "Realtime sync.", + "Scala sync." ], "type": "string" } @@ -15475,7 +15743,7 @@ }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "description": "Promote certain links based on predefined trigger queries." }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", @@ -16063,7 +16331,7 @@ "type": "array" }, "autoRunDisabled": { - "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.", + "description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs", "type": "boolean" }, "bapConfig": { @@ -16110,7 +16378,7 @@ "type": "array" }, "connectorType": { - "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system.", + "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ "CONNECTOR_TYPE_UNSPECIFIED", "THIRD_PARTY", @@ -16140,6 +16408,10 @@ "readOnly": true, "type": "string" }, + "createEuaSaas": { + "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.", + "type": "boolean" + }, "createTime": { "description": "Output only. Timestamp the DataConnector was created at.", "format": "google-datetime", @@ -16186,6 +16458,15 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." }, + "incrementalRefreshInterval": { + "description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days.", + "format": "google-duration", + "type": "string" + }, + "incrementalSyncDisabled": { + "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled.", + "type": "boolean" + }, "kmsKeyName": { "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", "type": "string" @@ -16296,12 +16577,14 @@ "enum": [ "PERIODIC", "STREAMING", - "UNSPECIFIED" + "UNSPECIFIED", + "SCALA_SYNC" ], "enumDescriptions": [ "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", "The data will be synced in real time.", - "Connector that doesn't ingest data will have this value" + "Connector that doesn't ingest data will have this value", + "The data will be synced with Scala Sync, a data ingestion solution." ], "type": "string" }, @@ -16492,7 +16775,7 @@ "description": "Language info for DataStore." }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "naturalLanguageQueryUnderstandingConfig": { @@ -16577,7 +16860,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "properties": { "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", + "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, @@ -17215,7 +17498,7 @@ "type": "string" }, "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, @@ -17230,7 +17513,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -17250,7 +17533,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "recommendationMetadata": { @@ -19246,6 +19529,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse": { + "description": "Response message for UserLicenseService.ListUserLicenses.", + "id": "GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "userLicenses": { + "description": "All the customer's UserLicenses.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaMediaInfo": { "description": "Media-specific user event information.", "id": "GoogleCloudDiscoveryengineV1alphaMediaInfo", @@ -21246,6 +21547,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, + "customSearchOperators": { + "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", + "type": "string" + }, "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" @@ -21746,10 +22051,6 @@ "description": "Rewritten input query minus the extracted filters.", "type": "string" }, - "sqlRequest": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest", - "description": "Optional. The SQL request that was generated from the natural language query understanding phase." - }, "structuredExtractedFilter": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", "description": "The filters that were extracted from the input query represented in a structured form." @@ -21757,17 +22058,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest": { - "description": "The SQL request that was generated from the natural language query understanding phase.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest", - "properties": { - "sqlQuery": { - "description": "Optional. The SQL query in text format.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { "description": "The filters that were extracted from the input query represented in a structured form.", "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", @@ -23342,6 +23632,66 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaUserLicense": { + "description": "User License information assigned by the admin.", + "id": "GoogleCloudDiscoveryengineV1alphaUserLicense", + "properties": { + "createTime": { + "description": "Output only. User created timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "lastLoginTime": { + "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "licenseAssignmentState": { + "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;", + "enum": [ + "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED", + "ASSIGNED", + "UNASSIGNED", + "NO_LICENSE", + "NO_LICENSE_ATTEMPTED_LOGIN" + ], + "enumDescriptions": [ + "Default value.", + "License assigned to the user.", + "No license assigned to the user. Deprecated, translated to NO_LICENSE.", + "No license assigned to the user.", + "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." + ], + "readOnly": true, + "type": "string" + }, + "licenseConfig": { + "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", + "type": "string" + }, + "updateTime": { + "description": "Output only. User update timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "user": { + "description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.", + "type": "string" + }, + "userPrincipal": { + "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.", + "type": "string" + }, + "userProfile": { + "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaWidgetConfig": { "description": "WidgetConfig captures configs at the Widget level.", "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfig", @@ -23443,6 +23793,11 @@ "description": "Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).", "type": "boolean" }, + "enablePrivateKnowledgeGraph": { + "description": "Optional. Output only. Whether to enable private knowledge graph.", + "readOnly": true, + "type": "boolean" + }, "enableQualityFeedback": { "deprecated": true, "description": "Turn on or off collecting the search result quality feedback from end users.", @@ -24305,7 +24660,7 @@ }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "description": "Promote certain links based on predefined trigger queries." }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", @@ -24696,7 +25051,7 @@ "description": "Language info for DataStore." }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "naturalLanguageQueryUnderstandingConfig": { @@ -24781,7 +25136,7 @@ "id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", "properties": { "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", + "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, @@ -25115,7 +25470,7 @@ "type": "string" }, "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, @@ -25130,7 +25485,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -25150,7 +25505,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "searchEngineConfig": { @@ -26700,6 +27055,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, + "customSearchOperators": { + "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", + "type": "string" + }, "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" @@ -27394,10 +27753,6 @@ "$ref": "ApiservingMediaRequestInfo", "description": "Media upload request metadata." }, - "projectId": { - "description": "The project (notebook) id of the uploaded source. Prefer to use the parent field instead.", - "type": "string" - }, "sourceId": { "description": "The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created.", "type": "string" diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index 2b101ff9c1..9db58c4f67 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -719,7 +719,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -3304,7 +3304,7 @@ ], "parameters": { "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -4633,7 +4633,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -7849,6 +7849,85 @@ ] } } + }, + "userStores": { + "methods": { + "batchUpdateUserLicenses": { + "description": "Updates the User License. This method is used for batch assign/unassign licenses to users.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}:batchUpdateUserLicenses", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userStores.batchUpdateUserLicenses", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}:batchUpdateUserLicenses", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "userLicenses": { + "methods": { + "list": { + "description": "Lists the User Licenses.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userStores.userLicenses.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/userLicenses", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListUserLicensesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } }, @@ -7925,7 +8004,7 @@ } } }, - "revision": "20250425", + "revision": "20250519", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -8614,7 +8693,7 @@ }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1ControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "description": "Promote certain links based on predefined trigger queries." }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", @@ -8984,7 +9063,7 @@ "type": "string" }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "servingConfigDataStore": { @@ -9065,7 +9144,7 @@ "id": "GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore", "properties": { "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", + "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, @@ -9393,7 +9472,7 @@ "type": "string" }, "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, @@ -9408,7 +9487,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -9428,7 +9507,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "searchEngineConfig": { @@ -10941,7 +11020,8 @@ "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", "LOW_GROUNDED_ANSWER", - "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED", + "UNHELPFUL_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -10954,7 +11034,8 @@ "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", "The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", - "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification.", + "The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted." ], "type": "string" }, @@ -11555,12 +11636,14 @@ "enum": [ "CONNECTOR_MODE_UNSPECIFIED", "DATA_INGESTION", - "ACTIONS" + "ACTIONS", + "END_USER_AUTHENTICATION" ], "enumDescriptions": [ "Connector mode unspecified.", "Connector utilized for data ingestion.", - "Connector utilized for Actions" + "Connector utilized for Actions", + "Connector utilized for End User Authentication." ], "type": "string" }, @@ -11600,6 +11683,54 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata": { + "description": "Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of user licenses that failed to be updated.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of user licenses successfully updated.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse": { + "description": "Response message for UserLicenseService.BatchUpdateUserLicenses method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "userLicenses": { + "description": "UserLicenses successfully updated.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserLicense" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCmekConfig": { "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.", "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig", @@ -11944,13 +12075,15 @@ "SYNC_TYPE_UNSPECIFIED", "FULL", "INCREMENTAL", - "REALTIME" + "REALTIME", + "SCALA_SYNC" ], "enumDescriptions": [ "Sync type unspecified.", "Sync triggers full sync of all documents.", "Incremental sync of updated documents.", - "Realtime sync." + "Realtime sync.", + "Scala sync." ], "type": "string" } @@ -12016,7 +12149,7 @@ }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "description": "Promote certain links based on predefined trigger queries." }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", @@ -12342,7 +12475,7 @@ "type": "array" }, "autoRunDisabled": { - "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.", + "description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs", "type": "boolean" }, "bapConfig": { @@ -12389,7 +12522,7 @@ "type": "array" }, "connectorType": { - "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system.", + "description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.", "enum": [ "CONNECTOR_TYPE_UNSPECIFIED", "THIRD_PARTY", @@ -12419,6 +12552,10 @@ "readOnly": true, "type": "string" }, + "createEuaSaas": { + "description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.", + "type": "boolean" + }, "createTime": { "description": "Output only. Timestamp the DataConnector was created at.", "format": "google-datetime", @@ -12465,6 +12602,15 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig", "description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector." }, + "incrementalRefreshInterval": { + "description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days.", + "format": "google-duration", + "type": "string" + }, + "incrementalSyncDisabled": { + "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled.", + "type": "boolean" + }, "kmsKeyName": { "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.", "type": "string" @@ -12575,12 +12721,14 @@ "enum": [ "PERIODIC", "STREAMING", - "UNSPECIFIED" + "UNSPECIFIED", + "SCALA_SYNC" ], "enumDescriptions": [ "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", "The data will be synced in real time.", - "Connector that doesn't ingest data will have this value" + "Connector that doesn't ingest data will have this value", + "The data will be synced with Scala Sync, a data ingestion solution." ], "type": "string" }, @@ -12771,7 +12919,7 @@ "description": "Language info for DataStore." }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "naturalLanguageQueryUnderstandingConfig": { @@ -12856,7 +13004,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore", "properties": { "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", + "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, @@ -13277,7 +13425,7 @@ "type": "string" }, "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, @@ -13292,7 +13440,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -13312,7 +13460,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "recommendationMetadata": { @@ -15565,6 +15713,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, + "customSearchOperators": { + "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", + "type": "string" + }, "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" @@ -16344,6 +16496,66 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaUserLicense": { + "description": "User License information assigned by the admin.", + "id": "GoogleCloudDiscoveryengineV1alphaUserLicense", + "properties": { + "createTime": { + "description": "Output only. User created timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "lastLoginTime": { + "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "licenseAssignmentState": { + "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;", + "enum": [ + "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED", + "ASSIGNED", + "UNASSIGNED", + "NO_LICENSE", + "NO_LICENSE_ATTEMPTED_LOGIN" + ], + "enumDescriptions": [ + "Default value.", + "License assigned to the user.", + "No license assigned to the user. Deprecated, translated to NO_LICENSE.", + "No license assigned to the user.", + "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." + ], + "readOnly": true, + "type": "string" + }, + "licenseConfig": { + "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", + "type": "string" + }, + "updateTime": { + "description": "Output only. User update timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "user": { + "description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.", + "type": "string" + }, + "userPrincipal": { + "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.", + "type": "string" + }, + "userProfile": { + "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", @@ -16765,7 +16977,8 @@ "CUSTOMER_POLICY_VIOLATION", "NON_ANSWER_SEEKING_QUERY_IGNORED_V2", "LOW_GROUNDED_ANSWER", - "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED" + "USER_DEFINED_CLASSIFICATION_QUERY_IGNORED", + "UNHELPFUL_ANSWER" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -16778,7 +16991,8 @@ "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", "The non-answer seeking query ignored case. Google skips the answer if the query doesn't have clear intent.", "The low-grounded answer case. Google skips the answer if a well grounded answer was unable to be generated.", - "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification." + "The user defined query classification ignored case. Google skips the answer if the query is classified as a user defined query classification.", + "The unhelpful answer case. Google skips the answer if the answer is not helpful. This can be due to a variety of factors, including but not limited to: the query is not answerable, the answer is not relevant to the query, or the answer is not well-formatted." ], "type": "string" }, @@ -18154,6 +18368,44 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest": { + "description": "Request message for UserLicenseService.BatchUpdateUserLicenses method.", + "id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest", + "properties": { + "deleteUnassignedUserLicenses": { + "description": "Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state.", + "type": "boolean" + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaGcsSource", + "description": "Cloud Storage location for the input content." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource", + "description": "The inline source for the input content for document embeddings." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource": { + "description": "The inline source for the input config for BatchUpdateUserLicenses method.", + "id": "GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource", + "properties": { + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "type": "string" + }, + "userLicenses": { + "description": "Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserLicense" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest": { "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", "id": "GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest", @@ -18441,7 +18693,7 @@ "type": "boolean" }, "score": { - "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true.", + "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.", "format": "double", "type": "number" }, @@ -18481,6 +18733,14 @@ "readOnly": true, "type": "array" }, + "annotationMetadata": { + "description": "Output only. The annotation metadata includes structured content in the current chunk.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaChunkAnnotationMetadata" + }, + "readOnly": true, + "type": "array" + }, "chunkMetadata": { "$ref": "GoogleCloudDiscoveryengineV1betaChunkChunkMetadata", "description": "Output only. Metadata of the current chunk.", @@ -18532,6 +18792,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaChunkAnnotationMetadata": { + "description": "The annotation metadata includes structured content in the current chunk.", + "id": "GoogleCloudDiscoveryengineV1betaChunkAnnotationMetadata", + "properties": { + "imageId": { + "description": "Output only. Image id is provided if the structured content is based on an image.", + "readOnly": true, + "type": "string" + }, + "structuredContent": { + "$ref": "GoogleCloudDiscoveryengineV1betaChunkStructuredContent", + "description": "Output only. The structured content information.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaChunkChunkMetadata": { "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", "id": "GoogleCloudDiscoveryengineV1betaChunkChunkMetadata", @@ -18593,6 +18870,35 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaChunkStructuredContent": { + "description": "The structured content information.", + "id": "GoogleCloudDiscoveryengineV1betaChunkStructuredContent", + "properties": { + "content": { + "description": "Output only. The content of the structured content.", + "readOnly": true, + "type": "string" + }, + "structureType": { + "description": "Output only. The structure type of the structured content.", + "enum": [ + "STRUCTURE_TYPE_UNSPECIFIED", + "SHAREHOLDER_STRUCTURE", + "SIGNATURE_STRUCTURE", + "CHECKBOX_STRUCTURE" + ], + "enumDescriptions": [ + "Default value.", + "Shareholder structure.", + "Signature structure.", + "Checkbox structure." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaCloudSqlSource": { "description": "Cloud SQL source import data from.", "id": "GoogleCloudDiscoveryengineV1betaCloudSqlSource", @@ -18890,7 +19196,7 @@ }, "promoteAction": { "$ref": "GoogleCloudDiscoveryengineV1betaControlPromoteAction", - "description": "Promote certain links based on predefined trigger queries. This now only supports basic site search." + "description": "Promote certain links based on predefined trigger queries." }, "redirectAction": { "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", @@ -19543,7 +19849,7 @@ "description": "Language info for DataStore." }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "naturalLanguageQueryUnderstandingConfig": { @@ -19628,7 +19934,7 @@ "id": "GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore", "properties": { "disabledForServing": { - "description": "If set true, the DataStore will not be available for serving search requests.", + "description": "Optional. If set true, the DataStore will not be available for serving search requests.", "type": "boolean" } }, @@ -20179,7 +20485,7 @@ "type": "string" }, "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "description": "Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, @@ -20194,7 +20500,7 @@ "type": "string" }, "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "description": "Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -20214,7 +20520,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, "searchEngineConfig": { @@ -21673,6 +21979,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaListUserLicensesResponse": { + "description": "Response message for UserLicenseService.ListUserLicenses.", + "id": "GoogleCloudDiscoveryengineV1betaListUserLicensesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "userLicenses": { + "description": "All the customer's UserLicenses.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserLicense" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaMediaInfo": { "description": "Media-specific user event information.", "id": "GoogleCloudDiscoveryengineV1betaMediaInfo", @@ -23273,6 +23597,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "description": "Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, + "customSearchOperators": { + "description": "Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).", + "type": "string" + }, "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" @@ -23773,10 +24101,6 @@ "description": "Rewritten input query minus the extracted filters.", "type": "string" }, - "sqlRequest": { - "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest", - "description": "Optional. The SQL request that was generated from the natural language query understanding phase." - }, "structuredExtractedFilter": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", "description": "The filters that were extracted from the input query represented in a structured form." @@ -23784,17 +24108,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest": { - "description": "The SQL request that was generated from the natural language query understanding phase.", - "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest", - "properties": { - "sqlQuery": { - "description": "Optional. The SQL query in text format.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { "description": "The filters that were extracted from the input query represented in a structured form.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", @@ -25199,6 +25512,66 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaUserLicense": { + "description": "User License information assigned by the admin.", + "id": "GoogleCloudDiscoveryengineV1betaUserLicense", + "properties": { + "createTime": { + "description": "Output only. User created timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "lastLoginTime": { + "description": "Output only. User last logged in time. If the user has not logged in yet, this field will be empty.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "licenseAssignmentState": { + "description": "Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;", + "enum": [ + "LICENSE_ASSIGNMENT_STATE_UNSPECIFIED", + "ASSIGNED", + "UNASSIGNED", + "NO_LICENSE", + "NO_LICENSE_ATTEMPTED_LOGIN" + ], + "enumDescriptions": [ + "Default value.", + "License assigned to the user.", + "No license assigned to the user. Deprecated, translated to NO_LICENSE.", + "No license assigned to the user.", + "User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." + ], + "readOnly": true, + "type": "string" + }, + "licenseConfig": { + "description": "Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.", + "type": "string" + }, + "updateTime": { + "description": "Output only. User update timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "user": { + "description": "Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created.", + "type": "string" + }, + "userPrincipal": { + "description": "Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.", + "type": "string" + }, + "userProfile": { + "description": "Optional. The user profile. We user user full name(First name + Last name) as user profile.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 65f8cd4bf4..d4db8f7f74 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -5113,7 +5113,7 @@ } } }, - "revision": "20250323", + "revision": "20250511", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -7179,7 +7179,7 @@ "type": "object" }, "GooglePrivacyDlpV2Deidentify": { - "description": "Create a de-identified copy of the requested table or files. A TransformationDetail will be created for each transformation. If any rows in BigQuery are skipped during de-identification (transformation errors or row size exceeds BigQuery insert API limits) they are placed in the failure output table. If the original row exceeds the BigQuery insert API limit it will be truncated when written to the failure output table. The failure output table can be set in the action.deidentify.output.big_query_output.deidentified_failure_output_table field, if no table is set, a table will be automatically created in the same project and dataset as the original table. Compatible with: Inspect", + "description": "Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage", "id": "GooglePrivacyDlpV2Deidentify", "properties": { "cloudStorageOutput": { @@ -7225,7 +7225,7 @@ }, "transformationDetailsStorageConfig": { "$ref": "GooglePrivacyDlpV2TransformationDetailsStorageConfig", - "description": "Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted)." + "description": "Config for storing transformation details. This field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred. Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation. Key use cases: * **Auditing and compliance** * Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies. * Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data. * **Troubleshooting and debugging** * Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline. * Helps pinpoint the exact location and nature of failures, speeding up the debugging process. * **Process verification and quality assurance** * Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended. * Helps in verifying the effectiveness of the chosen de-identification strategies. * **Data lineage and impact analysis** * Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data. * Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability. * **Reporting and operational insights** * You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied. * These insights can inform optimization of de-identification configurations and resource planning. To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data." } }, "type": "object" @@ -8621,7 +8621,7 @@ "type": "array" }, "fileStoreIsEmpty": { - "description": "The file store does not have any files. If the profiling failed, this will be false.", + "description": "The file store does not have any files. If the profiling operation failed, this is false.", "type": "boolean" }, "fileStoreLocation": { diff --git a/discovery/drive-v2.json b/discovery/drive-v2.json index 364d3ce053..61a66cbc94 100644 --- a/discovery/drive-v2.json +++ b/discovery/drive-v2.json @@ -2777,6 +2777,12 @@ "location": "query", "type": "string" }, + "enforceExpansiveAccess": { + "default": "false", + "description": "Whether the request should enforce expansive access rules.", + "location": "query", + "type": "boolean" + }, "enforceSingleParent": { "default": "false", "deprecated": true, @@ -3887,7 +3893,7 @@ } } }, - "revision": "20250427", + "revision": "20250506", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index a00d4ee8ca..a3d69024d4 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -669,7 +669,7 @@ ] }, "delete": { - "description": "Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter).", + "description": "Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments).", "flatPath": "files/{fileId}/comments/{commentId}", "httpMethod": "DELETE", "id": "drive.comments.delete", @@ -1949,6 +1949,12 @@ "location": "query", "type": "string" }, + "enforceExpansiveAccess": { + "default": "false", + "description": "Whether the request should enforce expansive access rules.", + "location": "query", + "type": "boolean" + }, "enforceSingleParent": { "default": "false", "deprecated": true, @@ -2800,7 +2806,7 @@ } } }, - "revision": "20250427", + "revision": "20250511", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/discovery/driveactivity-v2.json b/discovery/driveactivity-v2.json index ffcc4fc17e..650e868d6a 100644 --- a/discovery/driveactivity-v2.json +++ b/discovery/driveactivity-v2.json @@ -132,7 +132,7 @@ } } }, - "revision": "20250329", + "revision": "20250517", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { @@ -1141,7 +1141,7 @@ "The feature which changed restriction settings was not available.", "When restricted, this prevents items from being shared outside the domain.", "When restricted, this prevents direct sharing of individual items.", - "When restricted, this prevents actions like copy, download, and print that might result in uncontrolled duplicates of items.", + "When restricted, this prevents actions like copy, download, and print that might result in uncontrolled duplicates of items. Now deprecated in favor of READERS_CAN_DOWNLOAD.", "When restricted, this prevents use of Drive File Stream.", "When restricted, this limits sharing of folders to managers only." ], diff --git a/discovery/firebaseapphosting-v1.json b/discovery/firebaseapphosting-v1.json new file mode 100644 index 0000000000..2b2d611f28 --- /dev/null +++ b/discovery/firebaseapphosting-v1.json @@ -0,0 +1,2642 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://firebaseapphosting.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Firebase App Hosting", + "description": "Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub integration, and integration with other Firebase products. You can use this API to intervene in the Firebase App Hosting build process and add custom functionality not supported in our default Console & CLI flows, including triggering builds from external CI/CD workflows or deploying from pre-built container images. ", + "discoveryVersion": "v1", + "documentationLink": "https://firebase.google.com/docs/app-hosting", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "firebaseapphosting:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://firebaseapphosting.mtls.googleapis.com/", + "name": "firebaseapphosting", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "backends": { + "methods": { + "create": { + "description": "Creates a new backend in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.backends.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "backendId": { + "description": "Required. Id of the backend. Also used as the service ID for Cloud Run, and as part of the default domain name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. A parent name of the form `projects/{project}/locations/{locationId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he 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" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/backends", + "request": { + "$ref": "Backend" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single backend.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}", + "httpMethod": "DELETE", + "id": "firebaseapphosting.projects.locations.backends.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error.", + "location": "query", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any resources for this backend will also be deleted. Otherwise, any children resources will block deletion.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he 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" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated, without persisting the request or updating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a backend.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Backend" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists backends in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. A parent name of the form `projects/{project}/locations/{locationId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/backends", + "response": { + "$ref": "ListBackendsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the information for a single backend.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}", + "httpMethod": "PATCH", + "id": "firebaseapphosting.projects.locations.backends.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true, and the backend is not found, a new backend will be created.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the backend resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated, without persisting the request or updating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Backend" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "builds": { + "methods": { + "create": { + "description": "Creates a new build for a backend.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.backends.builds.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "buildId": { + "description": "Required. Desired ID of the build being created.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/builds", + "request": { + "$ref": "Build" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single build.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds/{buildsId}", + "httpMethod": "DELETE", + "id": "firebaseapphosting.projects.locations.backends.builds.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/builds/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a build.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds/{buildsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.builds.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/builds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Build" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists builds in a given project, location, and backend.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.builds.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the form `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/builds", + "response": { + "$ref": "ListBuildsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "domains": { + "methods": { + "create": { + "description": "Links a new domain to a backend.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.backends.domains.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "domainId": { + "description": "Required. Id of the domain to create. Must be a valid domain name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/domains", + "request": { + "$ref": "Domain" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single domain.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains/{domainsId}", + "httpMethod": "DELETE", + "id": "firebaseapphosting.projects.locations.backends.domains.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/domains/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a domain.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains/{domainsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.domains.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/domains/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Domain" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists domains of a backend.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.domains.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/domains", + "response": { + "$ref": "ListDomainsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the information for a single domain.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains/{domainsId}", + "httpMethod": "PATCH", + "id": "firebaseapphosting.projects.locations.backends.domains.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true, and the domain is not found, a new domain will be created.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/domains/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Domain resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or modifying any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Domain" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "rollouts": { + "methods": { + "create": { + "description": "Creates a new rollout for a backend.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/rollouts", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.backends.rollouts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "rolloutId": { + "description": "Optional. Desired ID of the rollout being created.", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/rollouts", + "request": { + "$ref": "Rollout" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a rollout.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/rollouts/{rolloutsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.rollouts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/rollouts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Rollout" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists rollouts for a backend.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/rollouts", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.rollouts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/rollouts", + "response": { + "$ref": "ListRolloutsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "traffic": { + "methods": { + "get": { + "description": "Gets information about a backend's traffic.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/traffic", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.traffic.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/traffic$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Traffic" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a backend's traffic.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/traffic", + "httpMethod": "PATCH", + "id": "firebaseapphosting.projects.locations.backends.traffic.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the backend's traffic. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/traffic$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the traffic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated, without persisting the request or updating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Traffic" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "firebaseapphosting.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20250501", + "rootUrl": "https://firebaseapphosting.googleapis.com/", + "schemas": { + "Backend": { + "description": "A backend is the primary resource of App Hosting.", + "id": "Backend", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", + "type": "object" + }, + "appId": { + "description": "Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.", + "type": "string" + }, + "codebase": { + "$ref": "Codebase", + "description": "Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend." + }, + "createTime": { + "description": "Output only. Time at which the backend was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. Time at which the backend was deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Human-readable name. 63 character limit.", + "type": "string" + }, + "environment": { + "description": "Optional. The environment name of the backend, used to load environment variables from environment specific configuration.", + "type": "string" + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects.", + "type": "object" + }, + "managedResources": { + "description": "Output only. A list of the resources managed by this backend.", + "items": { + "$ref": "ManagedResource" + }, + "readOnly": true, + "type": "array" + }, + "mode": { + "deprecated": true, + "description": "Optional. Deprecated: Use `environment` instead.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.", + "readOnly": true, + "type": "boolean" + }, + "serviceAccount": { + "description": "Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.", + "type": "string" + }, + "servingLocality": { + "description": "Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS).", + "enum": [ + "SERVING_LOCALITY_UNSPECIFIED", + "REGIONAL_STRICT", + "GLOBAL_ACCESS" + ], + "enumDescriptions": [ + "Unspecified. Will return an error if used.", + "In this mode, App Hosting serves your backend's content from your chosen parent region. App Hosting only maintains data and serving infrastructure in that chosen region and does not replicate your data to other regions.", + "In this mode, App Hosting serves your backend's content from multiple points-of-presence (POP) across the globe. App Hosting replicates your backend's configuration and cached data to these POPs and uses a global CDN to further decrease response latency. App Hosting-maintained Cloud Resources on your project, such as Cloud Run services, Cloud Build build, and Artifact Registry Images are still confined to your backend's parent region. Responses cached by the CDN may be stored in the POPs for the duration of the cache's TTL." + ], + "type": "string" + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the backend was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. The primary URI to communicate with the backend.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Build": { + "description": "A single build for a backend, at a specific point codebase reference tag and point in time. Encapsulates several resources, including an Artifact Registry container image, a Cloud Build invocation that built the image, and the Cloud Run revision that uses that image.", + "id": "Build", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", + "type": "object" + }, + "buildLogsUri": { + "description": "Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process.", + "readOnly": true, + "type": "string" + }, + "config": { + "$ref": "Config", + "description": "Optional. Additional configuration of the service." + }, + "createTime": { + "description": "Output only. Time at which the build was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. Time at which the build was deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Human-readable name. 63 character limit.", + "type": "string" + }, + "environment": { + "description": "Output only. The environment name of the backend when this build was created.", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "Output only. A list of all errors that occurred during an App Hosting build.", + "items": { + "$ref": "Error" + }, + "readOnly": true, + "type": "array" + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "image": { + "description": "Output only. The Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) URI, used by the Cloud Run [`revision`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services.revisions) for this build.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the build. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`.", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the build has an ongoing LRO.", + "readOnly": true, + "type": "boolean" + }, + "source": { + "$ref": "BuildSource", + "description": "Required. Immutable. The source for the build." + }, + "state": { + "description": "Output only. The state of the build.", + "enum": [ + "STATE_UNSPECIFIED", + "BUILDING", + "BUILT", + "DEPLOYING", + "READY", + "FAILED" + ], + "enumDescriptions": [ + "The build is in an unknown state.", + "The build is building.", + "The build has completed and is awaiting the next step. This may move to DEPLOYING once App Hosting starts to set up infrastructure.", + "The infrastructure for this build is being set up.", + "The infrastructure for this build is ready. The build may or may not be serving traffic - see `Backend.traffic` for the current state, or `Backend.traffic_statuses` for the desired state.", + "The build has failed." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the build was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BuildSource": { + "description": "The source for the build.", + "id": "BuildSource", + "properties": { + "codebase": { + "$ref": "CodebaseSource", + "description": "A codebase source." + }, + "container": { + "$ref": "ContainerSource", + "description": "An Artifact Registry container image source." + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "Codebase": { + "description": "The connection to an external source repository to watch for event-driven updates to the backend.", + "id": "Codebase", + "properties": { + "repository": { + "description": "Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.", + "type": "string" + }, + "rootDirectory": { + "description": "Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.", + "type": "string" + } + }, + "type": "object" + }, + "CodebaseSource": { + "description": "A codebase source, representing the state of the codebase that the build will be created at.", + "id": "CodebaseSource", + "properties": { + "author": { + "$ref": "UserMetadata", + "description": "Output only. The author contained in the metadata of a version control change.", + "readOnly": true + }, + "branch": { + "description": "The branch in the codebase to build from, using the latest commit.", + "type": "string" + }, + "commit": { + "description": "The commit in the codebase to build from.", + "type": "string" + }, + "commitMessage": { + "description": "Output only. The message of a codebase change.", + "readOnly": true, + "type": "string" + }, + "commitTime": { + "description": "Output only. The time the change was made.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com.", + "readOnly": true, + "type": "string" + }, + "hash": { + "description": "Output only. The full SHA-1 hash of a Git commit, if available.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Config": { + "description": "Additional configuration of the backend for this build.", + "id": "Config", + "properties": { + "env": { + "description": "Optional. Environment variables for this build.", + "items": { + "$ref": "EnvironmentVariable" + }, + "type": "array" + }, + "runConfig": { + "$ref": "RunConfig", + "description": "Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service)." + } + }, + "type": "object" + }, + "ContainerSource": { + "description": "The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source.", + "id": "ContainerSource", + "properties": { + "image": { + "description": "Required. A URI representing a container for the backend to use.", + "type": "string" + } + }, + "type": "object" + }, + "CustomDomainOperationMetadata": { + "description": "Additional metadata for operations on custom domains.", + "id": "CustomDomainOperationMetadata", + "properties": { + "certState": { + "description": "Output only. The custom domain's `CertState`, which must be `CERT_ACTIVE` for the create operations to complete.", + "enum": [ + "CERT_STATE_UNSPECIFIED", + "CERT_PREPARING", + "CERT_VALIDATING", + "CERT_PROPAGATING", + "CERT_ACTIVE", + "CERT_EXPIRING_SOON", + "CERT_EXPIRED" + ], + "enumDescriptions": [ + "The certificate's state is unspecified. The message is invalid if this is unspecified.", + "The initial state of every certificate, represents App Hosting's intent to create a certificate before requests to a Certificate Authority are made.", + "App Hosting is validating whether a domain name's DNS records are in a state that allow certificate creation on its behalf.", + "The certificate was recently created, and needs time to propagate in App Hosting's load balancers.", + "The certificate is active, providing secure connections for the domain names it represents.", + "The certificate is expiring, all domain names on it will be given new certificates.", + "The certificate has expired. App Hosting can no longer serve secure content on your domain name." + ], + "readOnly": true, + "type": "string" + }, + "hostState": { + "description": "Output only. The custom domain's `HostState`, which must be `HOST_ACTIVE` for Create operations of the domain name this `CustomDomain` refers toto complete.", + "enum": [ + "HOST_STATE_UNSPECIFIED", + "HOST_UNHOSTED", + "HOST_UNREACHABLE", + "HOST_NON_FAH", + "HOST_CONFLICT", + "HOST_WRONG_SHARD", + "HOST_ACTIVE" + ], + "enumDescriptions": [ + "Your custom domain's host state is unspecified. The message is invalid if this is unspecified.", + "Your custom domain isn't associated with any IP addresses.", + "Your custom domain can't be reached. App Hosting services' DNS queries to find your domain's IP addresses resulted in errors. See your `CustomDomainStatus`'s `issues` field for more details.", + "Your domain has only IP addresses that don't ultimately resolve to App Hosting.", + "Your domain has IP addresses that resolve to both App Hosting and to other services. To ensure consistent results, remove `A` and `AAAA` records related to non-App-Hosting services.", + "Your domain has IP addresses that resolve to an incorrect instance of the App Hosting Data Plane. App Hosting has multiple data plane instances to ensure high availability. The SSL certificate that App Hosting creates for your domain is only available on its assigned instance. If your domain's IP addresses resolve to an incorrect instance, App Hosting won't be able to serve secure content on it.", + "All requests against your domain are served by App Hosting, via your domain's assigned shard. If the custom domain's `OwnershipState` is also `OWNERSHIP_ACTIVE`, App Hosting serves its backend's content on requests for the domain." + ], + "readOnly": true, + "type": "string" + }, + "issues": { + "description": "Output only. A list of issues that are currently preventing the operation from completing. These are generally DNS-related issues encountered when querying a domain's records or attempting to mint an SSL certificate.", + "items": { + "$ref": "Status" + }, + "readOnly": true, + "type": "array" + }, + "liveMigrationSteps": { + "description": "Output only. A list of steps that the user must complete to migrate their domain to App Hosting without downtime.", + "items": { + "$ref": "LiveMigrationStep" + }, + "readOnly": true, + "type": "array" + }, + "ownershipState": { + "description": "Output only. The custom domain's `OwnershipState`, which must be `OWNERSHIP_ACTIVE` for the create operations to complete.", + "enum": [ + "OWNERSHIP_STATE_UNSPECIFIED", + "OWNERSHIP_MISSING", + "OWNERSHIP_UNREACHABLE", + "OWNERSHIP_MISMATCH", + "OWNERSHIP_CONFLICT", + "OWNERSHIP_PENDING", + "OWNERSHIP_ACTIVE" + ], + "enumDescriptions": [ + "Your custom domain's ownership state is unspecified. This should never happen.", + "Your custom domain's domain has no App-Hosting-related ownership records; no backend is authorized to serve on the domain in this Origin shard.", + "Your custom domain can't be reached. App Hosting services' DNS queries to find your domain's ownership records resulted in errors. See your `CustomDomainStatus`'s `issues` field for more details.", + "Your custom domain is owned by another App Hosting custom domain. Remove the conflicting records and replace them with records for your current custom domain.", + "Your custom domain has conflicting `TXT` records that indicate ownership by both your current custom domain one or more others. Remove the extraneous ownership records to grant the current custom domain ownership.", + "Your custom domain's DNS records are configured correctly. App Hosting will transfer ownership of your domain to this custom domain within 24 hours.", + "Your custom domain owns its domain." + ], + "readOnly": true, + "type": "string" + }, + "quickSetupUpdates": { + "description": "Output only. A set of DNS record updates to perform, to allow App Hosting to serve secure content on the domain.", + "items": { + "$ref": "DnsUpdates" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "CustomDomainStatus": { + "description": "The status of a custom domain's linkage to a backend.", + "id": "CustomDomainStatus", + "properties": { + "certState": { + "description": "Output only. Tracks SSL certificate status for the domain.", + "enum": [ + "CERT_STATE_UNSPECIFIED", + "CERT_PREPARING", + "CERT_VALIDATING", + "CERT_PROPAGATING", + "CERT_ACTIVE", + "CERT_EXPIRING_SOON", + "CERT_EXPIRED" + ], + "enumDescriptions": [ + "The certificate's state is unspecified. The message is invalid if this is unspecified.", + "The initial state of every certificate, represents App Hosting's intent to create a certificate before requests to a Certificate Authority are made.", + "App Hosting is validating whether a domain name's DNS records are in a state that allow certificate creation on its behalf.", + "The certificate was recently created, and needs time to propagate in App Hosting's load balancers.", + "The certificate is active, providing secure connections for the domain names it represents.", + "The certificate is expiring, all domain names on it will be given new certificates.", + "The certificate has expired. App Hosting can no longer serve secure content on your domain name." + ], + "readOnly": true, + "type": "string" + }, + "hostState": { + "description": "Output only. Tracks whether a custom domain is detected as appropriately directing traffic to App Hosting.", + "enum": [ + "HOST_STATE_UNSPECIFIED", + "HOST_UNHOSTED", + "HOST_UNREACHABLE", + "HOST_NON_FAH", + "HOST_CONFLICT", + "HOST_WRONG_SHARD", + "HOST_ACTIVE" + ], + "enumDescriptions": [ + "Your custom domain's host state is unspecified. The message is invalid if this is unspecified.", + "Your custom domain isn't associated with any IP addresses.", + "Your custom domain can't be reached. App Hosting services' DNS queries to find your domain's IP addresses resulted in errors. See your `CustomDomainStatus`'s `issues` field for more details.", + "Your domain has only IP addresses that don't ultimately resolve to App Hosting.", + "Your domain has IP addresses that resolve to both App Hosting and to other services. To ensure consistent results, remove `A` and `AAAA` records related to non-App-Hosting services.", + "Your domain has IP addresses that resolve to an incorrect instance of the App Hosting Data Plane. App Hosting has multiple data plane instances to ensure high availability. The SSL certificate that App Hosting creates for your domain is only available on its assigned instance. If your domain's IP addresses resolve to an incorrect instance, App Hosting won't be able to serve secure content on it.", + "All requests against your domain are served by App Hosting, via your domain's assigned shard. If the custom domain's `OwnershipState` is also `OWNERSHIP_ACTIVE`, App Hosting serves its backend's content on requests for the domain." + ], + "readOnly": true, + "type": "string" + }, + "issues": { + "description": "Output only. A list of issues with domain configuration. Allows users to self-correct problems with DNS records.", + "items": { + "$ref": "Status" + }, + "readOnly": true, + "type": "array" + }, + "ownershipState": { + "description": "Output only. Tracks whether the backend is permitted to serve content on the domain, based off the domain's DNS records.", + "enum": [ + "OWNERSHIP_STATE_UNSPECIFIED", + "OWNERSHIP_MISSING", + "OWNERSHIP_UNREACHABLE", + "OWNERSHIP_MISMATCH", + "OWNERSHIP_CONFLICT", + "OWNERSHIP_PENDING", + "OWNERSHIP_ACTIVE" + ], + "enumDescriptions": [ + "Your custom domain's ownership state is unspecified. This should never happen.", + "Your custom domain's domain has no App-Hosting-related ownership records; no backend is authorized to serve on the domain in this Origin shard.", + "Your custom domain can't be reached. App Hosting services' DNS queries to find your domain's ownership records resulted in errors. See your `CustomDomainStatus`'s `issues` field for more details.", + "Your custom domain is owned by another App Hosting custom domain. Remove the conflicting records and replace them with records for your current custom domain.", + "Your custom domain has conflicting `TXT` records that indicate ownership by both your current custom domain one or more others. Remove the extraneous ownership records to grant the current custom domain ownership.", + "Your custom domain's DNS records are configured correctly. App Hosting will transfer ownership of your domain to this custom domain within 24 hours.", + "Your custom domain owns its domain." + ], + "readOnly": true, + "type": "string" + }, + "requiredDnsUpdates": { + "description": "Output only. Lists the records that must added or removed to a custom domain's DNS in order to finish setup and start serving content. Field is present during onboarding. Also present after onboarding if one or more of the above states is not *_ACTIVE, indicating the domain's DNS records are in a bad state.", + "items": { + "$ref": "DnsUpdates" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "DnsRecord": { + "description": "A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files).", + "id": "DnsRecord", + "properties": { + "domainName": { + "description": "Output only. The domain the record pertains to, e.g. `foo.bar.com.`.", + "readOnly": true, + "type": "string" + }, + "rdata": { + "description": "Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue \"pki.goog\"`.", + "readOnly": true, + "type": "string" + }, + "relevantState": { + "description": "Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action.", + "items": { + "enum": [ + "CUSTOM_DOMAIN_STATE_UNSPECIFIED", + "HOST_STATE", + "OWNERSHIP_STATE", + "CERT_STATE" + ], + "enumDescriptions": [ + "This message is invalid if this is unspecified.", + "The custom domain's host state.", + "The custom domain's ownership state.", + "The custom domain's certificate state." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "requiredAction": { + "description": "Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set.", + "enum": [ + "NONE", + "ADD", + "REMOVE" + ], + "enumDescriptions": [ + "No action necessary.", + "Add this record to your DNS records.", + "Remove this record from your DNS records." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The record's type, which determines what data the record contains.", + "enum": [ + "TYPE_UNSPECIFIED", + "A", + "CNAME", + "TXT", + "AAAA", + "CAA" + ], + "enumDescriptions": [ + "The record's type is unspecified. The message is invalid if this is unspecified.", + "An `A` record, as defined in [RFC 1035](https://tools.ietf.org/html/rfc1035). A records determine which IPv4 addresses a domain directs traffic towards.", + "A `CNAME` record, as defined in [RFC 1035](https://tools.ietf.org/html/rfc1035). `CNAME` or Canonical Name records map a domain to a different, canonical domain. If a `CNAME` record is present, it should be the only record on the domain.", + "A `TXT` record, as defined in [RFC 1035](https://tools.ietf.org/html/rfc1035). `TXT` records hold arbitrary text data on a domain. Hosting uses `TXT` records to establish which Firebase Project has permission to act on a domain.", + "An AAAA record, as defined in [RFC 3596](https://tools.ietf.org/html/rfc3596) AAAA records determine which IPv6 addresses a domain directs traffic towards.", + "A CAA record, as defined in [RFC 6844](https://tools.ietf.org/html/rfc6844). CAA, or Certificate Authority Authorization, records determine which Certificate Authorities (SSL certificate minting organizations) are authorized to mint a certificate for the domain. App Hosting uses `pki.goog` as its primary CA. CAA records cascade. A CAA record on `foo.com` also applies to `bar.foo.com` unless `bar.foo.com` has its own set of CAA records. CAA records are optional. If a domain and its parents have no CAA records, all CAs are authorized to mint certificates on its behalf. In general, App Hosting only asks you to modify CAA records when doing so is required to unblock SSL cert creation." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DnsRecordSet": { + "description": "A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting.", + "id": "DnsRecordSet", + "properties": { + "checkError": { + "$ref": "Status", + "description": "Output only. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet.", + "readOnly": true + }, + "domainName": { + "description": "Output only. The domain name the record set pertains to.", + "readOnly": true, + "type": "string" + }, + "records": { + "description": "Output only. Records on the domain.", + "items": { + "$ref": "DnsRecord" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "DnsUpdates": { + "description": "A set of DNS record updates that you should make to allow App Hosting to serve secure content in response to requests against your domain. These updates present the current state of your domain's and related subdomains' DNS records when App Hosting last queried them, and the desired set of records that App Hosting needs to see before your custom domain can be fully active.", + "id": "DnsUpdates", + "properties": { + "checkTime": { + "description": "Output only. The last time App Hosting checked your custom domain's DNS records.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "desired": { + "description": "Output only. The set of DNS records App Hosting needs in order to be able to serve secure content on the domain.", + "items": { + "$ref": "DnsRecordSet" + }, + "readOnly": true, + "type": "array" + }, + "discovered": { + "description": "Output only. The set of DNS records App Hosting discovered when inspecting a domain.", + "items": { + "$ref": "DnsRecordSet" + }, + "readOnly": true, + "type": "array" + }, + "domainName": { + "description": "Output only. The domain name the DNS updates pertain to.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Domain": { + "description": "A domain name that is associated with a backend.", + "id": "Domain", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Annotations as key value pairs.", + "type": "object" + }, + "createTime": { + "description": "Output only. Time at which the domain was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customDomainStatus": { + "$ref": "CustomDomainStatus", + "description": "Output only. Represents the state and configuration of a `CUSTOM` type domain. It is only present on Domains of that type.", + "readOnly": true + }, + "deleteTime": { + "description": "Output only. Time at which the domain was deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "disabled": { + "description": "Optional. Whether the domain is disabled. Defaults to false.", + "type": "boolean" + }, + "displayName": { + "description": "Optional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`.", + "type": "string" + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com`", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the build has an ongoing LRO.", + "readOnly": true, + "type": "boolean" + }, + "serve": { + "$ref": "ServingBehavior", + "description": "Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content." + }, + "type": { + "description": "Output only. The type of the domain.", + "enum": [ + "TYPE_UNSPECIFIED", + "DEFAULT", + "CUSTOM" + ], + "enumDescriptions": [ + "The type is unspecified (this should not happen).", + "Default, App Hosting-provided and managed domains. These domains are created automatically with their parent backend and cannot be deleted except by deleting that parent, and cannot be moved to another backend. Default domains can be disabled via the `disabled` field.", + "Custom, developer-owned domains. Custom Domains allow you to associate a domain you own with your App Hosting backend, and configure that domain to serve your backend's content." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the domain was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DomainOperationMetadata": { + "description": "Represents the metadata of a long-running operation on domains.", + "id": "DomainOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customDomainOperationMetadata": { + "$ref": "CustomDomainOperationMetadata", + "description": "Output only. Additional metadata for operations on custom domains.", + "readOnly": true + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "EnvironmentVariable": { + "description": "Environment variables for this build.", + "id": "EnvironmentVariable", + "properties": { + "availability": { + "description": "Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND.", + "items": { + "enum": [ + "AVAILABILITY_UNSPECIFIED", + "BUILD", + "RUNTIME" + ], + "enumDescriptions": [ + "The default value, unspecified, which is unused.", + "This value is available when creating a Build from source code.", + "This value is available at runtime within Cloud Run." + ], + "type": "string" + }, + "type": "array" + }, + "secret": { + "description": "A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret.", + "type": "string" + }, + "value": { + "description": "A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration.", + "type": "string" + }, + "variable": { + "description": "Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with \"FIREBASE\" or \"GOOGLE\". - May not be a reserved environment variable for KNative/Cloud Run", + "type": "string" + } + }, + "type": "object" + }, + "Error": { + "description": "The container for the rpc status and source for any errors found during the build process.", + "id": "Error", + "properties": { + "cloudResource": { + "description": "Output only. Resource link", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "Output only. A status and (human readable) error message for the build, if in a `FAILED` state.", + "readOnly": true + }, + "errorSource": { + "description": "Output only. The source of the error for the build, if in a `FAILED` state.", + "enum": [ + "ERROR_SOURCE_UNSPECIFIED", + "CLOUD_BUILD", + "CLOUD_RUN" + ], + "enumDescriptions": [ + "Indicates that generic error occurred outside of the Cloud Build or Cloud Run processes, such as a pre-empted or user-canceled App Hosting Build.", + "Indicates that the build failed during the Cloud Build process, such as a build timeout.", + "Indicates that the build failed during the Cloud Run process, such as a service creation failure." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ListBackendsResponse": { + "description": "Message for response to list backends", + "id": "ListBackendsResponse", + "properties": { + "backends": { + "description": "The list of backends", + "items": { + "$ref": "Backend" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListBuildsResponse": { + "description": "Message for response to list builds.", + "id": "ListBuildsResponse", + "properties": { + "builds": { + "description": "The list of builds.", + "items": { + "$ref": "Build" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListDomainsResponse": { + "description": "Message for response to list domains.", + "id": "ListDomainsResponse", + "properties": { + "domains": { + "description": "Output only. The list of domains.", + "items": { + "$ref": "Domain" + }, + "readOnly": true, + "type": "array" + }, + "nextPageToken": { + "description": "Output only. A token identifying the next page of results the server should return.", + "readOnly": true, + "type": "string" + }, + "unreachable": { + "description": "Output only. Locations that could not be reached.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRolloutsResponse": { + "description": "Message for response to list rollouts.", + "id": "ListRolloutsResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying the next page of results the server should return.", + "type": "string" + }, + "rollouts": { + "description": "The list of rollouts.", + "items": { + "$ref": "Rollout" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LiveMigrationStep": { + "description": "A set of updates including ACME challenges and DNS records that allow App Hosting to create an SSL certificate and establish project ownership for your domain name before you direct traffic to App Hosting servers. Use these updates to facilitate zero downtime migrations to App Hosting from other services. After you've made the recommended updates, check your custom domain's `ownershipState` and `certState`. To avoid downtime, they should be `OWNERSHIP_ACTIVE` and `CERT_ACTIVE`, respectively, before you update your `A` and `AAAA` records.", + "id": "LiveMigrationStep", + "properties": { + "dnsUpdates": { + "description": "Output only. DNS updates to facilitate your domain's zero-downtime migration to App Hosting.", + "items": { + "$ref": "DnsUpdates" + }, + "readOnly": true, + "type": "array" + }, + "issues": { + "description": "Output only. Issues that prevent the current step from completing.", + "items": { + "$ref": "Status" + }, + "readOnly": true, + "type": "array" + }, + "relevantDomainStates": { + "description": "Output only. One or more states from the `CustomDomainStatus` of the migrating domain that this step is attempting to make ACTIVE. For example, if the step is attempting to mint an SSL certificate, this field will include `CERT_STATE`.", + "items": { + "enum": [ + "CUSTOM_DOMAIN_STATE_UNSPECIFIED", + "HOST_STATE", + "OWNERSHIP_STATE", + "CERT_STATE" + ], + "enumDescriptions": [ + "This message is invalid if this is unspecified.", + "The custom domain's host state.", + "The custom domain's ownership state.", + "The custom domain's certificate state." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "stepState": { + "description": "Output only. The state of the live migration step, indicates whether you should work to complete the step now, in the future, or have already completed it.", + "enum": [ + "STEP_STATE_UNSPECIFIED", + "PREPARING", + "PENDING", + "INCOMPLETE", + "PROCESSING", + "COMPLETE" + ], + "enumDescriptions": [ + "The step's state is unspecified. The message is invalid if this is unspecified.", + "App Hosting doesn't have enough information to construct the step yet. Complete any prior steps and/or resolve this step's issue to proceed.", + "The step's state is pending. Complete prior steps before working on a `PENDING` step.", + "The step is incomplete. You should complete any `dnsUpdates` changes to complete it.", + "You've done your part to update records and present challenges as necessary. App Hosting is now completing background processes to complete the step, e.g. minting an SSL cert for your domain.", + "The step is complete. You've already made the necessary changes to your domain and/or prior hosting service to advance to the next step. Once all steps are complete, App Hosting is ready to serve secure content on your domain." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "ManagedResource": { + "description": "An external resource managed by App Hosting on the project.", + "id": "ManagedResource", + "properties": { + "runService": { + "$ref": "RunService", + "description": "A Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service), managed by App Hosting." + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of a long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Redirect": { + "description": "Specifies redirect behavior for a domain.", + "id": "Redirect", + "properties": { + "status": { + "description": "Optional. The status code to use in a redirect response. Must be a valid HTTP 3XX status code. Defaults to 302 if not present.", + "format": "int64", + "type": "string" + }, + "uri": { + "description": "Required. The URI of the redirect's intended destination. This URI will be prepended to the original request path. URI without a scheme are assumed to be HTTPS.", + "type": "string" + } + }, + "type": "object" + }, + "Rollout": { + "description": "A single rollout of a build for a backend.", + "id": "Rollout", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", + "type": "object" + }, + "build": { + "description": "Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic.", + "type": "string" + }, + "createTime": { + "description": "Output only. Time at which the rollout was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. Time at which the rollout was deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Human-readable name. 63 character limit.", + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "Output only. A status and (human readable) error message for the rollout, if in a `FAILED` state.", + "readOnly": true + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the rollout. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}`.", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the Rollout currently has an LRO.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The state of the rollout.", + "enum": [ + "STATE_UNSPECIFIED", + "QUEUED", + "PENDING_BUILD", + "PROGRESSING", + "PAUSED", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "The rollout is in an unknown state.", + "The rollout is waiting for actuation to begin. This may be because it is waiting on another rollout to complete.", + "The rollout is waiting for the build process to complete, which builds the code and sets up the underlying infrastructure.", + "The rollout has started and is actively modifying traffic.", + "The rollout has been paused due to either being manually paused or a PAUSED stage. This should be set while `paused = true`.", + "The rollout has completed.", + "The rollout has failed. See error for more information.", + "The rollout has been cancelled." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the rollout was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RolloutPolicy": { + "description": "The policy for how automatic builds and rollouts are triggered and rolled out.", + "id": "RolloutPolicy", + "properties": { + "codebaseBranch": { + "description": "If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen.", + "type": "string" + }, + "disabled": { + "description": "Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy.", + "type": "boolean" + }, + "disabledTime": { + "description": "Output only. If `disabled` is set, the time at which the automatic rollouts were disabled.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RunConfig": { + "description": "Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).", + "id": "RunConfig", + "properties": { + "concurrency": { + "description": "Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000.", + "format": "int32", + "type": "integer" + }, + "cpu": { + "description": "Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB", + "format": "float", + "type": "number" + }, + "maxInstances": { + "description": "Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits.", + "format": "int32", + "type": "integer" + }, + "memoryMib": { + "description": "Optional. Amount of memory allocated for each serving instance in MiB. By default, memory defaults to the Cloud Run's default where each instance is allocated 512 MiB of memory. Memory can be set to any integer value between 128 to 32768. Increasing memory limit may require increase in CPUs limits: - Over 4 GiB: at least 2 CPUs - Over 8 GiB: at least 4 CPUs - Over 16 GiB: at least 6 CPUs - Over 24 GiB: at least 8 CPUs", + "format": "int32", + "type": "integer" + }, + "minInstances": { + "description": "Optional. Number of Cloud Run instances to maintain at minimum for each Cloud Run Service. By default, there are no minimum. Even if the service splits traffic across multiple revisions, the total number of instances for a service will be capped at this value.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "RunService": { + "description": "A managed Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).", + "id": "RunService", + "properties": { + "service": { + "description": "Optional. The name of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service), in the format: `projects/{project}/locations/{location}/services/{serviceId}`", + "type": "string" + } + }, + "type": "object" + }, + "ServingBehavior": { + "description": "Indicates whether App Hosting will serve content on the domain.", + "id": "ServingBehavior", + "properties": { + "redirect": { + "$ref": "Redirect", + "description": "Optional. Redirect behavior for a domain, if provided." + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "Traffic": { + "description": "Controls traffic configuration for the backend.", + "id": "Traffic", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", + "type": "object" + }, + "createTime": { + "description": "Output only. Time at which the backend was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "current": { + "$ref": "TrafficSet", + "description": "Output only. Current state of traffic allocation for the backend. When setting `target`, this field may differ for some time until the desired state is reached.", + "readOnly": true + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the backend's traffic. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the system is working to make the backend's `current` match the requested `target` list.", + "readOnly": true, + "type": "boolean" + }, + "rolloutPolicy": { + "$ref": "RolloutPolicy", + "description": "A rollout policy specifies how new builds and automatic deployments are created." + }, + "target": { + "$ref": "TrafficSet", + "description": "Set to manually control the desired traffic for the backend. This will cause `current` to eventually match this value. The percentages must add up to 100%." + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the backend was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TrafficSet": { + "description": "A list of traffic splits that together represent where traffic is being routed.", + "id": "TrafficSet", + "properties": { + "splits": { + "description": "Required. The list of traffic splits.", + "items": { + "$ref": "TrafficSplit" + }, + "type": "array" + } + }, + "type": "object" + }, + "TrafficSplit": { + "description": "The traffic allocation for the backend.", + "id": "TrafficSplit", + "properties": { + "build": { + "description": "Required. The build that traffic is being routed to.", + "type": "string" + }, + "percent": { + "description": "Required. The percentage of traffic to send to the build. Currently must be 100% or 0%.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "UserMetadata": { + "description": "Version control metadata for a user associated with a resolved codebase. Currently assumes a Git user.", + "id": "UserMetadata", + "properties": { + "displayName": { + "description": "Output only. The 'name' field in a Git user's git.config. Required by Git.", + "readOnly": true, + "type": "string" + }, + "email": { + "description": "Output only. The 'email' field in a Git user's git.config, if available.", + "readOnly": true, + "type": "string" + }, + "imageUri": { + "description": "Output only. The URI of an image file associated with the user's account in an external source control provider, if available.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Firebase App Hosting API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/firebaseapphosting-v1beta.json b/discovery/firebaseapphosting-v1beta.json new file mode 100644 index 0000000000..f9655ad525 --- /dev/null +++ b/discovery/firebaseapphosting-v1beta.json @@ -0,0 +1,2714 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://firebaseapphosting.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Firebase App Hosting", + "description": "Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub integration, and integration with other Firebase products. You can use this API to intervene in the Firebase App Hosting build process and add custom functionality not supported in our default Console & CLI flows, including triggering builds from external CI/CD workflows or deploying from pre-built container images. ", + "discoveryVersion": "v1", + "documentationLink": "https://firebase.google.com/docs/app-hosting", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "firebaseapphosting:v1beta", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://firebaseapphosting.mtls.googleapis.com/", + "name": "firebaseapphosting", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1beta/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "backends": { + "methods": { + "create": { + "description": "Creates a new backend in a given project and location.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.backends.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "backendId": { + "description": "Required. Id of the backend. Also used as the service ID for Cloud Run, and as part of the default domain name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. A parent name of the form `projects/{project}/locations/{locationId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he 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" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/backends", + "request": { + "$ref": "Backend" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single backend.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}", + "httpMethod": "DELETE", + "id": "firebaseapphosting.projects.locations.backends.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error.", + "location": "query", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any resources for this backend will also be deleted. Otherwise, any children resources will block deletion.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he 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" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated, without persisting the request or updating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a backend.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Backend" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists backends in a given project and location.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. A parent name of the form `projects/{project}/locations/{locationId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/backends", + "response": { + "$ref": "ListBackendsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the information for a single backend.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}", + "httpMethod": "PATCH", + "id": "firebaseapphosting.projects.locations.backends.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true, and the backend is not found, a new backend will be created.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the backend resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated, without persisting the request or updating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "Backend" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "builds": { + "methods": { + "create": { + "description": "Creates a new build for a backend.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.backends.builds.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "buildId": { + "description": "Required. Desired ID of the build being created.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/builds", + "request": { + "$ref": "Build" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single build.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds/{buildsId}", + "httpMethod": "DELETE", + "id": "firebaseapphosting.projects.locations.backends.builds.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/builds/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a build.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds/{buildsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.builds.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/builds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Build" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists builds in a given project, location, and backend.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/builds", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.builds.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the form `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/builds", + "response": { + "$ref": "ListBuildsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "domains": { + "methods": { + "create": { + "description": "Links a new domain to a backend.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.backends.domains.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "domainId": { + "description": "Required. Id of the domain to create. Must be a valid domain name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/domains", + "request": { + "$ref": "Domain" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single domain.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains/{domainsId}", + "httpMethod": "DELETE", + "id": "firebaseapphosting.projects.locations.backends.domains.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/domains/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a domain.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains/{domainsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.domains.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/domains/{domainId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/domains/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Domain" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists domains of a backend.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.domains.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/domains", + "response": { + "$ref": "ListDomainsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the information for a single domain.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/domains/{domainsId}", + "httpMethod": "PATCH", + "id": "firebaseapphosting.projects.locations.backends.domains.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true, and the domain is not found, a new domain will be created.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/domains/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Domain resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or modifying any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "Domain" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "rollouts": { + "methods": { + "create": { + "description": "Creates a new rollout for a backend.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/rollouts", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.backends.rollouts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "rolloutId": { + "description": "Optional. Desired ID of the rollout being created.", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/rollouts", + "request": { + "$ref": "Rollout" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a rollout.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/rollouts/{rolloutsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.rollouts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/rollouts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Rollout" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists rollouts for a backend.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/rollouts", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.rollouts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent backend in the format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+$", + "required": true, + "type": "string" + }, + "showDeleted": { + "description": "Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/rollouts", + "response": { + "$ref": "ListRolloutsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "traffic": { + "methods": { + "get": { + "description": "Gets information about a backend's traffic.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/traffic", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.backends.traffic.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource in the format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/traffic$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Traffic" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a backend's traffic.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/backends/{backendsId}/traffic", + "httpMethod": "PATCH", + "id": "firebaseapphosting.projects.locations.backends.traffic.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the backend's traffic. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backends/[^/]+/traffic$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the traffic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Indicates that the request should be validated, without persisting the request or updating any resources.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "Traffic" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "firebaseapphosting.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:cancel", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "firebaseapphosting.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "firebaseapphosting.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20250501", + "rootUrl": "https://firebaseapphosting.googleapis.com/", + "schemas": { + "ArchiveSource": { + "description": "The URI of an storage archive or a signed URL to use as the build source.", + "id": "ArchiveSource", + "properties": { + "author": { + "$ref": "SourceUserMetadata", + "description": "Optional. The author contained in the metadata of a version control change." + }, + "description": { + "description": "Optional. An optional message that describes the uploaded version of the source code.", + "type": "string" + }, + "externalSignedUri": { + "description": "Signed URL to an archive in a storage bucket.", + "type": "string" + }, + "rootDirectory": { + "description": "Optional. Relative path in the archive.", + "type": "string" + }, + "userStorageUri": { + "description": "URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy.", + "type": "string" + } + }, + "type": "object" + }, + "Backend": { + "description": "A backend is the primary resource of App Hosting.", + "id": "Backend", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", + "type": "object" + }, + "appId": { + "description": "Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.", + "type": "string" + }, + "codebase": { + "$ref": "Codebase", + "description": "Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend." + }, + "createTime": { + "description": "Output only. Time at which the backend was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. Time at which the backend was deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Human-readable name. 63 character limit.", + "type": "string" + }, + "environment": { + "description": "Optional. The environment name of the backend, used to load environment variables from environment specific configuration.", + "type": "string" + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects.", + "type": "object" + }, + "managedResources": { + "description": "Output only. A list of the resources managed by this backend.", + "items": { + "$ref": "ManagedResource" + }, + "readOnly": true, + "type": "array" + }, + "mode": { + "deprecated": true, + "description": "Optional. Deprecated: Use `environment` instead.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.", + "readOnly": true, + "type": "boolean" + }, + "serviceAccount": { + "description": "Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.", + "type": "string" + }, + "servingLocality": { + "description": "Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS).", + "enum": [ + "SERVING_LOCALITY_UNSPECIFIED", + "REGIONAL_STRICT", + "GLOBAL_ACCESS" + ], + "enumDescriptions": [ + "Unspecified. Will return an error if used.", + "In this mode, App Hosting serves your backend's content from your chosen parent region. App Hosting only maintains data and serving infrastructure in that chosen region and does not replicate your data to other regions.", + "In this mode, App Hosting serves your backend's content from multiple points-of-presence (POP) across the globe. App Hosting replicates your backend's configuration and cached data to these POPs and uses a global CDN to further decrease response latency. App Hosting-maintained Cloud Resources on your project, such as Cloud Run services, Cloud Build build, and Artifact Registry Images are still confined to your backend's parent region. Responses cached by the CDN may be stored in the POPs for the duration of the cache's TTL." + ], + "type": "string" + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the backend was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. The primary URI to communicate with the backend.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Build": { + "description": "A single build for a backend, at a specific point codebase reference tag and point in time. Encapsulates several resources, including an Artifact Registry container image, a Cloud Build invocation that built the image, and the Cloud Run revision that uses that image.", + "id": "Build", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", + "type": "object" + }, + "buildLogsUri": { + "description": "Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process.", + "readOnly": true, + "type": "string" + }, + "config": { + "$ref": "Config", + "description": "Optional. Additional configuration of the service." + }, + "createTime": { + "description": "Output only. Time at which the build was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. Time at which the build was deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Human-readable name. 63 character limit.", + "type": "string" + }, + "environment": { + "description": "Output only. The environment name of the backend when this build was created.", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "Status", + "deprecated": true, + "description": "Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated. Use `errors` instead.", + "readOnly": true + }, + "errorSource": { + "deprecated": true, + "description": "Output only. The source of the error for the build, if in a `FAILED` state. Deprecated. Use `errors` instead.", + "enum": [ + "ERROR_SOURCE_UNSPECIFIED", + "CLOUD_BUILD", + "CLOUD_RUN" + ], + "enumDescriptions": [ + "Indicates that generic error occurred outside of the Cloud Build or Cloud Run processes, such as a pre-empted or user-canceled App Hosting Build.", + "Indicates that the build failed during the Cloud Build process, such as a build timeout.", + "Indicates that the build failed during the Cloud Run process, such as a service creation failure." + ], + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "Output only. A list of all errors that occurred during an App Hosting build.", + "items": { + "$ref": "Error" + }, + "readOnly": true, + "type": "array" + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "image": { + "description": "Output only. The Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) URI, used by the Cloud Run [`revision`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services.revisions) for this build.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the build. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}`.", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the build has an ongoing LRO.", + "readOnly": true, + "type": "boolean" + }, + "source": { + "$ref": "BuildSource", + "description": "Required. Immutable. The source for the build." + }, + "state": { + "description": "Output only. The state of the build.", + "enum": [ + "STATE_UNSPECIFIED", + "BUILDING", + "BUILT", + "DEPLOYING", + "READY", + "FAILED" + ], + "enumDescriptions": [ + "The build is in an unknown state.", + "The build is building.", + "The build has completed and is awaiting the next step. This may move to DEPLOYING once App Hosting starts to set up infrastructure.", + "The infrastructure for this build is being set up.", + "The infrastructure for this build is ready. The build may or may not be serving traffic - see `Backend.traffic` for the current state, or `Backend.traffic_statuses` for the desired state.", + "The build has failed." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the build was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BuildSource": { + "description": "The source for the build.", + "id": "BuildSource", + "properties": { + "archive": { + "$ref": "ArchiveSource", + "description": "An archive source." + }, + "codebase": { + "$ref": "CodebaseSource", + "description": "A codebase source." + }, + "container": { + "$ref": "ContainerSource", + "description": "An Artifact Registry container image source." + } + }, + "type": "object" + }, + "Codebase": { + "description": "The connection to an external source repository to watch for event-driven updates to the backend.", + "id": "Codebase", + "properties": { + "repository": { + "description": "Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.", + "type": "string" + }, + "rootDirectory": { + "description": "Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.", + "type": "string" + } + }, + "type": "object" + }, + "CodebaseSource": { + "description": "A codebase source, representing the state of the codebase that the build will be created at.", + "id": "CodebaseSource", + "properties": { + "author": { + "$ref": "UserMetadata", + "description": "Output only. The author contained in the metadata of a version control change.", + "readOnly": true + }, + "branch": { + "description": "The branch in the codebase to build from, using the latest commit.", + "type": "string" + }, + "commit": { + "description": "The commit in the codebase to build from.", + "type": "string" + }, + "commitMessage": { + "description": "Output only. The message of a codebase change.", + "readOnly": true, + "type": "string" + }, + "commitTime": { + "description": "Output only. The time the change was made.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com.", + "readOnly": true, + "type": "string" + }, + "hash": { + "description": "Output only. The full SHA-1 hash of a Git commit, if available.", + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Config": { + "description": "Additional configuration of the backend for this build.", + "id": "Config", + "properties": { + "env": { + "description": "Optional. Environment variables for this build.", + "items": { + "$ref": "EnvironmentVariable" + }, + "type": "array" + }, + "runConfig": { + "$ref": "RunConfig", + "description": "Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service)." + } + }, + "type": "object" + }, + "ContainerSource": { + "description": "The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source.", + "id": "ContainerSource", + "properties": { + "image": { + "description": "Required. A URI representing a container for the backend to use.", + "type": "string" + } + }, + "type": "object" + }, + "CustomDomainOperationMetadata": { + "description": "Additional metadata for operations on custom domains.", + "id": "CustomDomainOperationMetadata", + "properties": { + "certState": { + "description": "Output only. The custom domain's `CertState`, which must be `CERT_ACTIVE` for the create operations to complete.", + "enum": [ + "CERT_STATE_UNSPECIFIED", + "CERT_PREPARING", + "CERT_VALIDATING", + "CERT_PROPAGATING", + "CERT_ACTIVE", + "CERT_EXPIRING_SOON", + "CERT_EXPIRED" + ], + "enumDescriptions": [ + "The certificate's state is unspecified. The message is invalid if this is unspecified.", + "The initial state of every certificate, represents App Hosting's intent to create a certificate before requests to a Certificate Authority are made.", + "App Hosting is validating whether a domain name's DNS records are in a state that allow certificate creation on its behalf.", + "The certificate was recently created, and needs time to propagate in App Hosting's load balancers.", + "The certificate is active, providing secure connections for the domain names it represents.", + "The certificate is expiring, all domain names on it will be given new certificates.", + "The certificate has expired. App Hosting can no longer serve secure content on your domain name." + ], + "readOnly": true, + "type": "string" + }, + "hostState": { + "description": "Output only. The custom domain's `HostState`, which must be `HOST_ACTIVE` for Create operations of the domain name this `CustomDomain` refers toto complete.", + "enum": [ + "HOST_STATE_UNSPECIFIED", + "HOST_UNHOSTED", + "HOST_UNREACHABLE", + "HOST_NON_FAH", + "HOST_CONFLICT", + "HOST_WRONG_SHARD", + "HOST_ACTIVE" + ], + "enumDescriptions": [ + "Your custom domain's host state is unspecified. The message is invalid if this is unspecified.", + "Your custom domain isn't associated with any IP addresses.", + "Your custom domain can't be reached. App Hosting services' DNS queries to find your domain's IP addresses resulted in errors. See your `CustomDomainStatus`'s `issues` field for more details.", + "Your domain has only IP addresses that don't ultimately resolve to App Hosting.", + "Your domain has IP addresses that resolve to both App Hosting and to other services. To ensure consistent results, remove `A` and `AAAA` records related to non-App-Hosting services.", + "Your domain has IP addresses that resolve to an incorrect instance of the App Hosting Data Plane. App Hosting has multiple data plane instances to ensure high availability. The SSL certificate that App Hosting creates for your domain is only available on its assigned instance. If your domain's IP addresses resolve to an incorrect instance, App Hosting won't be able to serve secure content on it.", + "All requests against your domain are served by App Hosting, via your domain's assigned shard. If the custom domain's `OwnershipState` is also `OWNERSHIP_ACTIVE`, App Hosting serves its backend's content on requests for the domain." + ], + "readOnly": true, + "type": "string" + }, + "issues": { + "description": "Output only. A list of issues that are currently preventing the operation from completing. These are generally DNS-related issues encountered when querying a domain's records or attempting to mint an SSL certificate.", + "items": { + "$ref": "Status" + }, + "readOnly": true, + "type": "array" + }, + "liveMigrationSteps": { + "description": "Output only. A list of steps that the user must complete to migrate their domain to App Hosting without downtime.", + "items": { + "$ref": "LiveMigrationStep" + }, + "readOnly": true, + "type": "array" + }, + "ownershipState": { + "description": "Output only. The custom domain's `OwnershipState`, which must be `OWNERSHIP_ACTIVE` for the create operations to complete.", + "enum": [ + "OWNERSHIP_STATE_UNSPECIFIED", + "OWNERSHIP_MISSING", + "OWNERSHIP_UNREACHABLE", + "OWNERSHIP_MISMATCH", + "OWNERSHIP_CONFLICT", + "OWNERSHIP_PENDING", + "OWNERSHIP_ACTIVE" + ], + "enumDescriptions": [ + "Your custom domain's ownership state is unspecified. This should never happen.", + "Your custom domain's domain has no App-Hosting-related ownership records; no backend is authorized to serve on the domain in this Origin shard.", + "Your custom domain can't be reached. App Hosting services' DNS queries to find your domain's ownership records resulted in errors. See your `CustomDomainStatus`'s `issues` field for more details.", + "Your custom domain is owned by another App Hosting custom domain. Remove the conflicting records and replace them with records for your current custom domain.", + "Your custom domain has conflicting `TXT` records that indicate ownership by both your current custom domain one or more others. Remove the extraneous ownership records to grant the current custom domain ownership.", + "Your custom domain's DNS records are configured correctly. App Hosting will transfer ownership of your domain to this custom domain within 24 hours.", + "Your custom domain owns its domain." + ], + "readOnly": true, + "type": "string" + }, + "quickSetupUpdates": { + "description": "Output only. A set of DNS record updates to perform, to allow App Hosting to serve secure content on the domain.", + "items": { + "$ref": "DnsUpdates" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "CustomDomainStatus": { + "description": "The status of a custom domain's linkage to a backend.", + "id": "CustomDomainStatus", + "properties": { + "certState": { + "description": "Output only. Tracks SSL certificate status for the domain.", + "enum": [ + "CERT_STATE_UNSPECIFIED", + "CERT_PREPARING", + "CERT_VALIDATING", + "CERT_PROPAGATING", + "CERT_ACTIVE", + "CERT_EXPIRING_SOON", + "CERT_EXPIRED" + ], + "enumDescriptions": [ + "The certificate's state is unspecified. The message is invalid if this is unspecified.", + "The initial state of every certificate, represents App Hosting's intent to create a certificate before requests to a Certificate Authority are made.", + "App Hosting is validating whether a domain name's DNS records are in a state that allow certificate creation on its behalf.", + "The certificate was recently created, and needs time to propagate in App Hosting's load balancers.", + "The certificate is active, providing secure connections for the domain names it represents.", + "The certificate is expiring, all domain names on it will be given new certificates.", + "The certificate has expired. App Hosting can no longer serve secure content on your domain name." + ], + "readOnly": true, + "type": "string" + }, + "hostState": { + "description": "Output only. Tracks whether a custom domain is detected as appropriately directing traffic to App Hosting.", + "enum": [ + "HOST_STATE_UNSPECIFIED", + "HOST_UNHOSTED", + "HOST_UNREACHABLE", + "HOST_NON_FAH", + "HOST_CONFLICT", + "HOST_WRONG_SHARD", + "HOST_ACTIVE" + ], + "enumDescriptions": [ + "Your custom domain's host state is unspecified. The message is invalid if this is unspecified.", + "Your custom domain isn't associated with any IP addresses.", + "Your custom domain can't be reached. App Hosting services' DNS queries to find your domain's IP addresses resulted in errors. See your `CustomDomainStatus`'s `issues` field for more details.", + "Your domain has only IP addresses that don't ultimately resolve to App Hosting.", + "Your domain has IP addresses that resolve to both App Hosting and to other services. To ensure consistent results, remove `A` and `AAAA` records related to non-App-Hosting services.", + "Your domain has IP addresses that resolve to an incorrect instance of the App Hosting Data Plane. App Hosting has multiple data plane instances to ensure high availability. The SSL certificate that App Hosting creates for your domain is only available on its assigned instance. If your domain's IP addresses resolve to an incorrect instance, App Hosting won't be able to serve secure content on it.", + "All requests against your domain are served by App Hosting, via your domain's assigned shard. If the custom domain's `OwnershipState` is also `OWNERSHIP_ACTIVE`, App Hosting serves its backend's content on requests for the domain." + ], + "readOnly": true, + "type": "string" + }, + "issues": { + "description": "Output only. A list of issues with domain configuration. Allows users to self-correct problems with DNS records.", + "items": { + "$ref": "Status" + }, + "readOnly": true, + "type": "array" + }, + "ownershipState": { + "description": "Output only. Tracks whether the backend is permitted to serve content on the domain, based off the domain's DNS records.", + "enum": [ + "OWNERSHIP_STATE_UNSPECIFIED", + "OWNERSHIP_MISSING", + "OWNERSHIP_UNREACHABLE", + "OWNERSHIP_MISMATCH", + "OWNERSHIP_CONFLICT", + "OWNERSHIP_PENDING", + "OWNERSHIP_ACTIVE" + ], + "enumDescriptions": [ + "Your custom domain's ownership state is unspecified. This should never happen.", + "Your custom domain's domain has no App-Hosting-related ownership records; no backend is authorized to serve on the domain in this Origin shard.", + "Your custom domain can't be reached. App Hosting services' DNS queries to find your domain's ownership records resulted in errors. See your `CustomDomainStatus`'s `issues` field for more details.", + "Your custom domain is owned by another App Hosting custom domain. Remove the conflicting records and replace them with records for your current custom domain.", + "Your custom domain has conflicting `TXT` records that indicate ownership by both your current custom domain one or more others. Remove the extraneous ownership records to grant the current custom domain ownership.", + "Your custom domain's DNS records are configured correctly. App Hosting will transfer ownership of your domain to this custom domain within 24 hours.", + "Your custom domain owns its domain." + ], + "readOnly": true, + "type": "string" + }, + "requiredDnsUpdates": { + "description": "Output only. Lists the records that must added or removed to a custom domain's DNS in order to finish setup and start serving content. Field is present during onboarding. Also present after onboarding if one or more of the above states is not *_ACTIVE, indicating the domain's DNS records are in a bad state.", + "items": { + "$ref": "DnsUpdates" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "DnsRecord": { + "description": "A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files).", + "id": "DnsRecord", + "properties": { + "domainName": { + "description": "Output only. The domain the record pertains to, e.g. `foo.bar.com.`.", + "readOnly": true, + "type": "string" + }, + "rdata": { + "description": "Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue \"pki.goog\"`.", + "readOnly": true, + "type": "string" + }, + "relevantState": { + "description": "Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action.", + "items": { + "enum": [ + "CUSTOM_DOMAIN_STATE_UNSPECIFIED", + "HOST_STATE", + "OWNERSHIP_STATE", + "CERT_STATE" + ], + "enumDescriptions": [ + "This message is invalid if this is unspecified.", + "The custom domain's host state.", + "The custom domain's ownership state.", + "The custom domain's certificate state." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "requiredAction": { + "description": "Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set.", + "enum": [ + "NONE", + "ADD", + "REMOVE" + ], + "enumDescriptions": [ + "No action necessary.", + "Add this record to your DNS records.", + "Remove this record from your DNS records." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The record's type, which determines what data the record contains.", + "enum": [ + "TYPE_UNSPECIFIED", + "A", + "CNAME", + "TXT", + "AAAA", + "CAA" + ], + "enumDescriptions": [ + "The record's type is unspecified. The message is invalid if this is unspecified.", + "An `A` record, as defined in [RFC 1035](https://tools.ietf.org/html/rfc1035). A records determine which IPv4 addresses a domain directs traffic towards.", + "A `CNAME` record, as defined in [RFC 1035](https://tools.ietf.org/html/rfc1035). `CNAME` or Canonical Name records map a domain to a different, canonical domain. If a `CNAME` record is present, it should be the only record on the domain.", + "A `TXT` record, as defined in [RFC 1035](https://tools.ietf.org/html/rfc1035). `TXT` records hold arbitrary text data on a domain. Hosting uses `TXT` records to establish which Firebase Project has permission to act on a domain.", + "An AAAA record, as defined in [RFC 3596](https://tools.ietf.org/html/rfc3596) AAAA records determine which IPv6 addresses a domain directs traffic towards.", + "A CAA record, as defined in [RFC 6844](https://tools.ietf.org/html/rfc6844). CAA, or Certificate Authority Authorization, records determine which Certificate Authorities (SSL certificate minting organizations) are authorized to mint a certificate for the domain. App Hosting uses `pki.goog` as its primary CA. CAA records cascade. A CAA record on `foo.com` also applies to `bar.foo.com` unless `bar.foo.com` has its own set of CAA records. CAA records are optional. If a domain and its parents have no CAA records, all CAs are authorized to mint certificates on its behalf. In general, App Hosting only asks you to modify CAA records when doing so is required to unblock SSL cert creation." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DnsRecordSet": { + "description": "A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting.", + "id": "DnsRecordSet", + "properties": { + "checkError": { + "$ref": "Status", + "description": "Output only. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet.", + "readOnly": true + }, + "domainName": { + "description": "Output only. The domain name the record set pertains to.", + "readOnly": true, + "type": "string" + }, + "records": { + "description": "Output only. Records on the domain.", + "items": { + "$ref": "DnsRecord" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "DnsUpdates": { + "description": "A set of DNS record updates that you should make to allow App Hosting to serve secure content in response to requests against your domain. These updates present the current state of your domain's and related subdomains' DNS records when App Hosting last queried them, and the desired set of records that App Hosting needs to see before your custom domain can be fully active.", + "id": "DnsUpdates", + "properties": { + "checkTime": { + "description": "Output only. The last time App Hosting checked your custom domain's DNS records.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "desired": { + "description": "Output only. The set of DNS records App Hosting needs in order to be able to serve secure content on the domain.", + "items": { + "$ref": "DnsRecordSet" + }, + "readOnly": true, + "type": "array" + }, + "discovered": { + "description": "Output only. The set of DNS records App Hosting discovered when inspecting a domain.", + "items": { + "$ref": "DnsRecordSet" + }, + "readOnly": true, + "type": "array" + }, + "domainName": { + "description": "Output only. The domain name the DNS updates pertain to.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Domain": { + "description": "A domain name that is associated with a backend.", + "id": "Domain", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Annotations as key value pairs.", + "type": "object" + }, + "createTime": { + "description": "Output only. Time at which the domain was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customDomainStatus": { + "$ref": "CustomDomainStatus", + "description": "Output only. Represents the state and configuration of a `CUSTOM` type domain. It is only present on Domains of that type.", + "readOnly": true + }, + "deleteTime": { + "description": "Output only. Time at which the domain was deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "disabled": { + "description": "Optional. Whether the domain is disabled. Defaults to false.", + "type": "boolean" + }, + "displayName": { + "description": "Optional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`.", + "type": "string" + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com`", + "type": "string" + }, + "purgeTime": { + "description": "Output only. Time at which a soft-deleted domain will be purged, rendering in permanently deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the build has an ongoing LRO.", + "readOnly": true, + "type": "boolean" + }, + "serve": { + "$ref": "ServingBehavior", + "description": "Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content." + }, + "type": { + "description": "Output only. The type of the domain.", + "enum": [ + "TYPE_UNSPECIFIED", + "DEFAULT", + "CUSTOM" + ], + "enumDescriptions": [ + "The type is unspecified (this should not happen).", + "Default, App Hosting-provided and managed domains. These domains are created automatically with their parent backend and cannot be deleted except by deleting that parent, and cannot be moved to another backend. Default domains can be disabled via the `disabled` field.", + "Custom, developer-owned domains. Custom Domains allow you to associate a domain you own with your App Hosting backend, and configure that domain to serve your backend's content." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the domain was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DomainOperationMetadata": { + "description": "Represents the metadata of a long-running operation on domains.", + "id": "DomainOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customDomainOperationMetadata": { + "$ref": "CustomDomainOperationMetadata", + "description": "Output only. Additional metadata for operations on custom domains.", + "readOnly": true + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "EnvironmentVariable": { + "description": "Environment variables for this build.", + "id": "EnvironmentVariable", + "properties": { + "availability": { + "description": "Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND.", + "items": { + "enum": [ + "AVAILABILITY_UNSPECIFIED", + "BUILD", + "RUNTIME" + ], + "enumDescriptions": [ + "The default value, unspecified, which is unused.", + "This value is available when creating a Build from source code.", + "This value is available at runtime within Cloud Run." + ], + "type": "string" + }, + "type": "array" + }, + "secret": { + "description": "A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret.", + "type": "string" + }, + "value": { + "description": "A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration.", + "type": "string" + }, + "variable": { + "description": "Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with \"FIREBASE\" or \"GOOGLE\". - May not be a reserved environment variable for KNative/Cloud Run", + "type": "string" + } + }, + "type": "object" + }, + "Error": { + "description": "The container for the rpc status and source for any errors found during the build process.", + "id": "Error", + "properties": { + "cloudResource": { + "description": "Output only. Resource link", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "Output only. A status and (human readable) error message for the build, if in a `FAILED` state.", + "readOnly": true + }, + "errorSource": { + "description": "Output only. The source of the error for the build, if in a `FAILED` state.", + "enum": [ + "ERROR_SOURCE_UNSPECIFIED", + "CLOUD_BUILD", + "CLOUD_RUN" + ], + "enumDescriptions": [ + "Indicates that generic error occurred outside of the Cloud Build or Cloud Run processes, such as a pre-empted or user-canceled App Hosting Build.", + "Indicates that the build failed during the Cloud Build process, such as a build timeout.", + "Indicates that the build failed during the Cloud Run process, such as a service creation failure." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ListBackendsResponse": { + "description": "Message for response to list backends", + "id": "ListBackendsResponse", + "properties": { + "backends": { + "description": "The list of backends", + "items": { + "$ref": "Backend" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListBuildsResponse": { + "description": "Message for response to list builds.", + "id": "ListBuildsResponse", + "properties": { + "builds": { + "description": "The list of builds.", + "items": { + "$ref": "Build" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListDomainsResponse": { + "description": "Message for response to list domains.", + "id": "ListDomainsResponse", + "properties": { + "domains": { + "description": "Output only. The list of domains.", + "items": { + "$ref": "Domain" + }, + "readOnly": true, + "type": "array" + }, + "nextPageToken": { + "description": "Output only. A token identifying the next page of results the server should return.", + "readOnly": true, + "type": "string" + }, + "unreachable": { + "description": "Output only. Locations that could not be reached.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRolloutsResponse": { + "description": "Message for response to list rollouts.", + "id": "ListRolloutsResponse", + "properties": { + "nextPageToken": { + "description": "A token identifying the next page of results the server should return.", + "type": "string" + }, + "rollouts": { + "description": "The list of rollouts.", + "items": { + "$ref": "Rollout" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "LiveMigrationStep": { + "description": "A set of updates including ACME challenges and DNS records that allow App Hosting to create an SSL certificate and establish project ownership for your domain name before you direct traffic to App Hosting servers. Use these updates to facilitate zero downtime migrations to App Hosting from other services. After you've made the recommended updates, check your custom domain's `ownershipState` and `certState`. To avoid downtime, they should be `OWNERSHIP_ACTIVE` and `CERT_ACTIVE`, respectively, before you update your `A` and `AAAA` records.", + "id": "LiveMigrationStep", + "properties": { + "dnsUpdates": { + "description": "Output only. DNS updates to facilitate your domain's zero-downtime migration to App Hosting.", + "items": { + "$ref": "DnsUpdates" + }, + "readOnly": true, + "type": "array" + }, + "issues": { + "description": "Output only. Issues that prevent the current step from completing.", + "items": { + "$ref": "Status" + }, + "readOnly": true, + "type": "array" + }, + "relevantDomainStates": { + "description": "Output only. One or more states from the `CustomDomainStatus` of the migrating domain that this step is attempting to make ACTIVE. For example, if the step is attempting to mint an SSL certificate, this field will include `CERT_STATE`.", + "items": { + "enum": [ + "CUSTOM_DOMAIN_STATE_UNSPECIFIED", + "HOST_STATE", + "OWNERSHIP_STATE", + "CERT_STATE" + ], + "enumDescriptions": [ + "This message is invalid if this is unspecified.", + "The custom domain's host state.", + "The custom domain's ownership state.", + "The custom domain's certificate state." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "stepState": { + "description": "Output only. The state of the live migration step, indicates whether you should work to complete the step now, in the future, or have already completed it.", + "enum": [ + "STEP_STATE_UNSPECIFIED", + "PREPARING", + "PENDING", + "INCOMPLETE", + "PROCESSING", + "COMPLETE" + ], + "enumDescriptions": [ + "The step's state is unspecified. The message is invalid if this is unspecified.", + "App Hosting doesn't have enough information to construct the step yet. Complete any prior steps and/or resolve this step's issue to proceed.", + "The step's state is pending. Complete prior steps before working on a `PENDING` step.", + "The step is incomplete. You should complete any `dnsUpdates` changes to complete it.", + "You've done your part to update records and present challenges as necessary. App Hosting is now completing background processes to complete the step, e.g. minting an SSL cert for your domain.", + "The step is complete. You've already made the necessary changes to your domain and/or prior hosting service to advance to the next step. Once all steps are complete, App Hosting is ready to serve secure content on your domain." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "ManagedResource": { + "description": "An external resource managed by App Hosting on the project.", + "id": "ManagedResource", + "properties": { + "runService": { + "$ref": "RunService", + "description": "A Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service), managed by App Hosting." + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of a long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Redirect": { + "description": "Specifies redirect behavior for a domain.", + "id": "Redirect", + "properties": { + "status": { + "description": "Optional. The status code to use in a redirect response. Must be a valid HTTP 3XX status code. Defaults to 302 if not present.", + "format": "int64", + "type": "string" + }, + "uri": { + "description": "Required. The URI of the redirect's intended destination. This URI will be prepended to the original request path. URI without a scheme are assumed to be HTTPS.", + "type": "string" + } + }, + "type": "object" + }, + "Rollout": { + "description": "A single rollout of a build for a backend.", + "id": "Rollout", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", + "type": "object" + }, + "build": { + "description": "Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic.", + "type": "string" + }, + "createTime": { + "description": "Output only. Time at which the rollout was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. Time at which the rollout was deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Human-readable name. 63 character limit.", + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "Output only. A status and (human readable) error message for the rollout, if in a `FAILED` state.", + "readOnly": true + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the rollout. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/rollouts/{rolloutId}`.", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the Rollout currently has an LRO.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The state of the rollout.", + "enum": [ + "STATE_UNSPECIFIED", + "QUEUED", + "PENDING_BUILD", + "PROGRESSING", + "PAUSED", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "The rollout is in an unknown state.", + "The rollout is waiting for actuation to begin. This may be because it is waiting on another rollout to complete.", + "The rollout is waiting for the build process to complete, which builds the code and sets up the underlying infrastructure.", + "The rollout has started and is actively modifying traffic.", + "The rollout has been paused due to either being manually paused or a PAUSED stage. This should be set while `paused = true`.", + "The rollout has completed.", + "The rollout has failed. See error for more information.", + "The rollout has been cancelled." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the rollout was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RolloutPolicy": { + "description": "The policy for how automatic builds and rollouts are triggered and rolled out.", + "id": "RolloutPolicy", + "properties": { + "codebaseBranch": { + "description": "If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen.", + "type": "string" + }, + "disabled": { + "description": "Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy.", + "type": "boolean" + }, + "disabledTime": { + "description": "Output only. If `disabled` is set, the time at which the automatic rollouts were disabled.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RunConfig": { + "description": "Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).", + "id": "RunConfig", + "properties": { + "concurrency": { + "description": "Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000.", + "format": "int32", + "type": "integer" + }, + "cpu": { + "description": "Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB", + "format": "float", + "type": "number" + }, + "maxInstances": { + "description": "Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits.", + "format": "int32", + "type": "integer" + }, + "memoryMib": { + "description": "Optional. Amount of memory allocated for each serving instance in MiB. By default, memory defaults to the Cloud Run's default where each instance is allocated 512 MiB of memory. Memory can be set to any integer value between 128 to 32768. Increasing memory limit may require increase in CPUs limits: - Over 4 GiB: at least 2 CPUs - Over 8 GiB: at least 4 CPUs - Over 16 GiB: at least 6 CPUs - Over 24 GiB: at least 8 CPUs", + "format": "int32", + "type": "integer" + }, + "minInstances": { + "description": "Optional. Number of Cloud Run instances to maintain at minimum for each Cloud Run Service. By default, there are no minimum. Even if the service splits traffic across multiple revisions, the total number of instances for a service will be capped at this value.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "RunService": { + "description": "A managed Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).", + "id": "RunService", + "properties": { + "service": { + "description": "Optional. The name of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service), in the format: `projects/{project}/locations/{location}/services/{serviceId}`", + "type": "string" + } + }, + "type": "object" + }, + "ServingBehavior": { + "description": "Indicates whether App Hosting will serve content on the domain.", + "id": "ServingBehavior", + "properties": { + "redirect": { + "$ref": "Redirect", + "description": "Optional. Redirect behavior for a domain, if provided." + } + }, + "type": "object" + }, + "SourceUserMetadata": { + "description": "Metadata for the user who started the build.", + "id": "SourceUserMetadata", + "properties": { + "displayName": { + "description": "Output only. The user-chosen displayname. May be empty.", + "readOnly": true, + "type": "string" + }, + "email": { + "description": "Output only. The account email linked to the EUC that created the build. May be a service account or other robot account.", + "readOnly": true, + "type": "string" + }, + "imageUri": { + "description": "Output only. The URI of a profile photo associated with the user who created the build.", + "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", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "Traffic": { + "description": "Controls traffic configuration for the backend.", + "id": "Traffic", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.", + "type": "object" + }, + "createTime": { + "description": "Output only. Time at which the backend was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "current": { + "$ref": "TrafficSet", + "description": "Output only. Current state of traffic allocation for the backend. When setting `target`, this field may differ for some time until the desired state is reached.", + "readOnly": true + }, + "etag": { + "description": "Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Unstructured key value map that can be used to organize and categorize objects.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the backend's traffic. Format: `projects/{project}/locations/{locationId}/backends/{backendId}/traffic`.", + "type": "string" + }, + "reconciling": { + "description": "Output only. A field that, if true, indicates that the system is working to make the backend's `current` match the requested `target` list.", + "readOnly": true, + "type": "boolean" + }, + "rolloutPolicy": { + "$ref": "RolloutPolicy", + "description": "A rollout policy specifies how new builds and automatic deployments are created." + }, + "target": { + "$ref": "TrafficSet", + "description": "Set to manually control the desired traffic for the backend. This will cause `current` to eventually match this value. The percentages must add up to 100%." + }, + "uid": { + "description": "Output only. System-assigned, unique identifier.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time at which the backend was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TrafficSet": { + "description": "A list of traffic splits that together represent where traffic is being routed.", + "id": "TrafficSet", + "properties": { + "splits": { + "description": "Required. The list of traffic splits.", + "items": { + "$ref": "TrafficSplit" + }, + "type": "array" + } + }, + "type": "object" + }, + "TrafficSplit": { + "description": "The traffic allocation for the backend.", + "id": "TrafficSplit", + "properties": { + "build": { + "description": "Required. The build that traffic is being routed to.", + "type": "string" + }, + "percent": { + "description": "Required. The percentage of traffic to send to the build. Currently must be 100% or 0%.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "UserMetadata": { + "description": "Version control metadata for a user associated with a resolved codebase. Currently assumes a Git user.", + "id": "UserMetadata", + "properties": { + "displayName": { + "description": "Output only. The 'name' field in a Git user's git.config. Required by Git.", + "readOnly": true, + "type": "string" + }, + "email": { + "description": "Output only. The 'email' field in a Git user's git.config, if available.", + "readOnly": true, + "type": "string" + }, + "imageUri": { + "description": "Output only. The URI of an image file associated with the user's account in an external source control provider, if available.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Firebase App Hosting API", + "version": "v1beta", + "version_module": true +} \ No newline at end of file diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index a321f83537..174e5bbe34 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20250427", + "revision": "20250505", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1086,6 +1086,10 @@ "description": "Config for thinking features.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", "properties": { + "includeThoughts": { + "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", + "type": "boolean" + }, "thinkingBudget": { "description": "Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.", "format": "int32", diff --git a/discovery/gkebackup-v1.json b/discovery/gkebackup-v1.json index 91312b303d..ac67b88429 100644 --- a/discovery/gkebackup-v1.json +++ b/discovery/gkebackup-v1.json @@ -2227,7 +2227,7 @@ } } }, - "revision": "20250414", + "revision": "20250507", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -2550,10 +2550,52 @@ }, "type": "object" }, + "BackupConfigDetails": { + "description": "BackupConfigDetails defines the configuration of Backups created via this BackupPlan.", + "id": "BackupConfigDetails", + "properties": { + "allNamespaces": { + "description": "Output only. If True, include all namespaced resources", + "readOnly": true, + "type": "boolean" + }, + "encryptionKey": { + "$ref": "EncryptionKey", + "description": "Output only. This defines a customer managed encryption key that will be used to encrypt the \"config\" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted.", + "readOnly": true + }, + "includeSecrets": { + "description": "Output only. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False", + "readOnly": true, + "type": "boolean" + }, + "includeVolumeData": { + "description": "Output only. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False", + "readOnly": true, + "type": "boolean" + }, + "selectedApplications": { + "$ref": "NamespacedNames", + "description": "Output only. If set, include just the resources referenced by the listed ProtectedApplications.", + "readOnly": true + }, + "selectedNamespaces": { + "$ref": "Namespaces", + "description": "Output only. If set, include just the resources in the listed namespaces.", + "readOnly": true + } + }, + "type": "object" + }, "BackupPlan": { "description": "Defines the configuration and scheduling for a \"line\" of Backups.", "id": "BackupPlan", "properties": { + "backupChannel": { + "description": "Output only. The fully qualified name of the BackupChannel to be used to create a backup. This field is set only if the cluster being backed up is in a different project. `projects/*/locations/*/backupChannels/*`", + "readOnly": true, + "type": "string" + }, "backupConfig": { "$ref": "BackupConfig", "description": "Optional. Defines the configuration of Backups created via this BackupPlan." @@ -2718,6 +2760,11 @@ "description": "Contains metadata about the backup plan/backup.", "id": "BackupPlanDetails", "properties": { + "backupConfigDetails": { + "$ref": "BackupConfigDetails", + "description": "Output only. Contains details about the BackupConfig of Backups created via this BackupPlan.", + "readOnly": true + }, "lastSuccessfulBackup": { "description": "Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/*/locations/*/backupPlans/*/backups/*`", "readOnly": true, @@ -2741,6 +2788,11 @@ "readOnly": true, "type": "integer" }, + "retentionPolicyDetails": { + "$ref": "RetentionPolicyDetails", + "description": "Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan.", + "readOnly": true + }, "rpoRiskLevel": { "description": "Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.", "format": "int32", @@ -3928,6 +3980,11 @@ "readOnly": true, "type": "string" }, + "restoreChannel": { + "description": "Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the `backup_plan` is in a different project than the RestorePlan. Format: `projects/*/locations/*/restoreChannels/*`", + "readOnly": true, + "type": "string" + }, "restoreConfig": { "$ref": "RestoreConfig", "description": "Required. Configuration of Restores created via this RestorePlan." @@ -4034,6 +4091,23 @@ }, "type": "object" }, + "RetentionPolicyDetails": { + "description": "RetentionPolicyDetails defines a Backup retention policy for a BackupPlan.", + "id": "RetentionPolicyDetails", + "properties": { + "backupDeleteLockDays": { + "description": "Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking)", + "format": "int32", + "type": "integer" + }, + "backupRetainDays": { + "description": "Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Default: 0 (no automatic deletion)", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "RpoConfig": { "description": "Defines RPO scheduling configuration for automatically creating Backups via this BackupPlan.", "id": "RpoConfig", diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index 6122da64d4..6e301099a0 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -2117,7 +2117,7 @@ } } }, - "revision": "20250423", + "revision": "20250509", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6259,6 +6259,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "THC_POD_UNSCHEDULABLE", "CLUSTER_HAS_ZERO_NODES", "CANONICAL_SERVICE_ERROR", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", @@ -6303,6 +6304,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "THC pod unschedulable error code", "Cluster has zero node code", "Failure to reconcile CanonicalServices", "Multiple control planes unsupported error code", diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 8a4bdff109..d89ce48d0d 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -2261,7 +2261,7 @@ } } }, - "revision": "20250423", + "revision": "20250509", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6843,6 +6843,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "THC_POD_UNSCHEDULABLE", "CLUSTER_HAS_ZERO_NODES", "CANONICAL_SERVICE_ERROR", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", @@ -6887,6 +6888,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "THC pod unschedulable error code", "Cluster has zero node code", "Failure to reconcile CanonicalServices", "Multiple control planes unsupported error code", @@ -7059,6 +7061,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "THC_POD_UNSCHEDULABLE", "CLUSTER_HAS_ZERO_NODES", "CANONICAL_SERVICE_ERROR", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", @@ -7103,6 +7106,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "THC pod unschedulable error code", "Cluster has zero node code", "Failure to reconcile CanonicalServices", "Multiple control planes unsupported error code", diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index cef9a78c60..c8646d2107 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -2117,7 +2117,7 @@ } } }, - "revision": "20250421", + "revision": "20250509", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6385,6 +6385,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "THC_POD_UNSCHEDULABLE", "CLUSTER_HAS_ZERO_NODES", "CANONICAL_SERVICE_ERROR", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", @@ -6429,6 +6430,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "THC pod unschedulable error code", "Cluster has zero node code", "Failure to reconcile CanonicalServices", "Multiple control planes unsupported error code", diff --git a/discovery/gkehub-v2.json b/discovery/gkehub-v2.json index 4e23fc9932..e5d2a76d27 100644 --- a/discovery/gkehub-v2.json +++ b/discovery/gkehub-v2.json @@ -477,7 +477,7 @@ } } }, - "revision": "20250415", + "revision": "20250509", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -3030,6 +3030,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "THC_POD_UNSCHEDULABLE", "CLUSTER_HAS_ZERO_NODES", "CANONICAL_SERVICE_ERROR", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", @@ -3074,6 +3075,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "THC pod unschedulable error code", "Cluster has zero node code", "Failure to reconcile CanonicalServices", "Multiple control planes unsupported error code", diff --git a/discovery/gkehub-v2alpha.json b/discovery/gkehub-v2alpha.json index cab771a886..55f93abee5 100644 --- a/discovery/gkehub-v2alpha.json +++ b/discovery/gkehub-v2alpha.json @@ -477,7 +477,7 @@ } } }, - "revision": "20250415", + "revision": "20250509", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -3030,6 +3030,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "THC_POD_UNSCHEDULABLE", "CLUSTER_HAS_ZERO_NODES", "CANONICAL_SERVICE_ERROR", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", @@ -3074,6 +3075,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "THC pod unschedulable error code", "Cluster has zero node code", "Failure to reconcile CanonicalServices", "Multiple control planes unsupported error code", diff --git a/discovery/gkehub-v2beta.json b/discovery/gkehub-v2beta.json index c10fcb4312..5478ba682f 100644 --- a/discovery/gkehub-v2beta.json +++ b/discovery/gkehub-v2beta.json @@ -477,7 +477,7 @@ } } }, - "revision": "20250415", + "revision": "20250509", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -3030,6 +3030,7 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "THC_POD_UNSCHEDULABLE", "CLUSTER_HAS_ZERO_NODES", "CANONICAL_SERVICE_ERROR", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", @@ -3074,6 +3075,7 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "THC pod unschedulable error code", "Cluster has zero node code", "Failure to reconcile CanonicalServices", "Multiple control planes unsupported error code", diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 6f0532bcab..221fa39d5a 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -3666,7 +3666,7 @@ ] }, "Patient-everything": { - "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).", + "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-operation-everything.html)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything", @@ -3749,7 +3749,7 @@ ] }, "Resource-validate": { - "description": "Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", + "description": "Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate), [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), or [R4](https://hl7.org/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/$validate", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate", @@ -3771,7 +3771,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", + "description": "Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), or [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -3832,7 +3832,7 @@ ] }, "capabilities": { - "description": "Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.", + "description": "Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.capabilities", @@ -3875,7 +3875,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", + "description": "Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -3909,7 +3909,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", + "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -3946,7 +3946,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", + "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -3966,7 +3966,7 @@ ] }, "create": { - "description": "Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).", + "description": "Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.create", @@ -3983,7 +3983,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", + "description": "Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -4003,7 +4003,7 @@ ] }, "delete": { - "description": "Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#delete), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).", + "description": "Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.delete", @@ -4029,7 +4029,7 @@ ] }, "executeBundle": { - "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).", + "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/fhir/STU3/http.html#transaction), [R4](https://hl7.org/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle", @@ -4058,7 +4058,7 @@ ] }, "history": { - "description": "Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions).", + "description": "Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https://hl7.org/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.history", @@ -4105,7 +4105,7 @@ ] }, "patch": { - "description": "Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).", + "description": "Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "PATCH", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.patch", @@ -4134,7 +4134,7 @@ ] }, "read": { - "description": "Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cread), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).", + "description": "Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.read", @@ -4160,7 +4160,7 @@ ] }, "search": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -4189,7 +4189,7 @@ ] }, "search-type": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", @@ -4206,7 +4206,7 @@ "type": "string" }, "resourceType": { - "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", + "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).", "location": "path", "required": true, "type": "string" @@ -4225,7 +4225,7 @@ ] }, "update": { - "description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", + "description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "PUT", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.update", @@ -4254,7 +4254,7 @@ ] }, "vread": { - "description": "Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).", + "description": "Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history/{_historyId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.vread", @@ -5094,7 +5094,7 @@ } } }, - "revision": "20250409", + "revision": "20250430", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -8424,7 +8424,7 @@ "id": "SearchResourcesRequest", "properties": { "resourceType": { - "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", + "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).", "type": "string" } }, diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index bba6ab6ad5..7be5f88079 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -4374,7 +4374,7 @@ ] }, "Encounter-everything": { - "description": "Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/encounter-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/implement/standards/fhir/R4/encounter-operation-everything.html). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the \"http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter\" extension.", + "description": "Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](https://hl7.org/fhir/DSTU2/encounter-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/fhir/R4/encounter-operation-everything.html). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the \"http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter\" extension.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Encounter/{EncounterId}/$everything", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Encounter-everything", @@ -4421,7 +4421,7 @@ ] }, "Observation-lastn": { - "description": "Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", + "description": "Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/fhir/R4/observation-operation-lastn.html)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Observation/$lastn", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn", @@ -4484,7 +4484,7 @@ ] }, "Patient-everything": { - "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).", + "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-operation-everything.html)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything", @@ -4619,7 +4619,7 @@ ] }, "Resource-validate": { - "description": "Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", + "description": "Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate), [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), or [R4](https://hl7.org/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/$validate", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate", @@ -4641,7 +4641,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", + "description": "Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), or [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -4702,7 +4702,7 @@ ] }, "capabilities": { - "description": "Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.", + "description": "Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.capabilities", @@ -4728,7 +4728,7 @@ ] }, "conditionalDelete": { - "description": "Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).", + "description": "Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete", @@ -4745,7 +4745,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", + "description": "Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -4762,7 +4762,7 @@ ] }, "conditionalPatch": { - "description": "If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).", + "description": "If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "PATCH", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch", @@ -4779,7 +4779,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", + "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -4799,7 +4799,7 @@ ] }, "conditionalUpdate": { - "description": "If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).", + "description": "If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](https://hl7.org/fhir/STU3/http.html#cond-update), [R4](https://hl7.org/fhir/R4/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "PUT", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate", @@ -4816,7 +4816,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", + "description": "Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -4836,7 +4836,7 @@ ] }, "create": { - "description": "Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).", + "description": "Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.create", @@ -4853,7 +4853,7 @@ "type": "string" }, "type": { - "description": "Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", + "description": "Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.", "location": "path", "pattern": "^[^/]+$", "required": true, @@ -4873,7 +4873,7 @@ ] }, "delete": { - "description": "Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#delete), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).", + "description": "Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.delete", @@ -4899,7 +4899,7 @@ ] }, "executeBundle": { - "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch`, `transaction` and `history`, processing `batch` and `transaction` bundles according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a `transaction` or `history` bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. `history` bundles also check the `import` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).", + "description": "Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/fhir/STU3/http.html#transaction), [R4](https://hl7.org/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch`, `transaction` and `history`, processing `batch` and `transaction` bundles according to the batch processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a `transaction` or `history` bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. `history` bundles also check the `import` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle", @@ -4928,7 +4928,7 @@ ] }, "history": { - "description": "Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions).", + "description": "Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https://hl7.org/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.history", @@ -4975,7 +4975,7 @@ ] }, "patch": { - "description": "Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).", + "description": "Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "PATCH", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.patch", @@ -5004,7 +5004,7 @@ ] }, "read": { - "description": "Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#read), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#cread), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).", + "description": "Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.read", @@ -5030,7 +5030,7 @@ ] }, "search": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", @@ -5059,7 +5059,7 @@ ] }, "search-type": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` \"next\", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{resourceType}/_search", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", @@ -5076,7 +5076,7 @@ "type": "string" }, "resourceType": { - "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", + "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).", "location": "path", "required": true, "type": "string" @@ -5095,7 +5095,7 @@ ] }, "update": { - "description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", + "description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "PUT", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.update", @@ -5124,7 +5124,7 @@ ] }, "vread": { - "description": "Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#vread), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).", + "description": "Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}/_history/{_historyId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.vread", @@ -6017,7 +6017,7 @@ } } }, - "revision": "20250409", + "revision": "20250430", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -10278,7 +10278,7 @@ "id": "SearchResourcesRequest", "properties": { "resourceType": { - "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", + "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)).", "type": "string" } }, diff --git a/discovery/iam-v1.json b/discovery/iam-v1.json index 9d002d8306..fd9441c224 100644 --- a/discovery/iam-v1.json +++ b/discovery/iam-v1.json @@ -1613,7 +1613,7 @@ ] }, "getIamPolicy": { - "description": "Gets IAM policies for one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity", + "description": "Gets the IAM policy of a WorkloadIdentityPool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:getIamPolicy", "httpMethod": "POST", "id": "iam.projects.locations.workloadIdentityPools.getIamPolicy", @@ -1716,7 +1716,7 @@ ] }, "setIamPolicy": { - "description": "Sets IAM policies on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity", + "description": "Sets the IAM policies on a WorkloadIdentityPool", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:setIamPolicy", "httpMethod": "POST", "id": "iam.projects.locations.workloadIdentityPools.setIamPolicy", @@ -1744,7 +1744,7 @@ ] }, "testIamPermissions": { - "description": "Returns the caller's permissions on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity", + "description": "Returns the caller's permissions on a WorkloadIdentityPool", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}:testIamPermissions", "httpMethod": "POST", "id": "iam.projects.locations.workloadIdentityPools.testIamPermissions", @@ -2105,7 +2105,7 @@ ] }, "list": { - "description": "Lists all non-deleted WorkloadIdentityPoolManagedIdentitys in a namespace. If `show_deleted` is set to `true`, then deleted managed identites are also listed.", + "description": "Lists all non-deleted WorkloadIdentityPoolManagedIdentitys in a namespace. If `show_deleted` is set to `true`, then deleted managed identities are also listed.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities", "httpMethod": "GET", "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.list", @@ -3773,7 +3773,7 @@ } } }, - "revision": "20250411", + "revision": "20250509", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4192,7 +4192,7 @@ "id": "GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientQueryParameters", "properties": { "filter": { - "description": "Optional. The filter used to request specific records from IdP. In case of attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter used to request specific groups for users from IdP. By default, all of the groups associated with the user are fetched. The groups should be mail enabled and security enabled. See https://learn.microsoft.com/en-us/graph/search-query-parameter for more details.", + "description": "Optional. The filter used to request specific records from the IdP. By default, all of the groups that are associated with a user are fetched. For Microsoft Entra ID, you can add `$search` query parameters using [Keyword Query Language] (https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). To learn more about `$search` querying in Microsoft Entra ID, see [Use the `$search` query parameter] (https://learn.microsoft.com/en-us/graph/search-query-parameter). Additionally, Workforce Identity Federation automatically adds the following [`$filter` query parameters] (https://learn.microsoft.com/en-us/graph/filter-query-parameter), based on the value of `attributes_type`. Values passed to `filter` are converted to `$search` query parameters. Additional `$filter` query parameters cannot be added using this field. * `AZURE_AD_GROUPS_MAIL`: `mailEnabled` and `securityEnabled` filters are applied. * `AZURE_AD_GROUPS_ID`: `securityEnabled` filter is applied.", "type": "string" } }, @@ -4313,11 +4313,11 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. A required mapping of a cloud region to the CA pool resource located in that region used for certificate issuance, adhering to these constraints: * Key format: A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * Value format: A valid CA pool resource path format like: \"projects/{project}/locations/{location}/caPools/{ca_pool}\" * Region Matching: Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key).", + "description": "Optional. A required mapping of a Google Cloud region to the CA pool resource located in that region. The CA pool is used for certificate issuance, adhering to the following constraints: * Key format: A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * Value format: A valid CA pool resource path format like: \"projects/{project}/locations/{location}/caPools/{ca_pool}\" * Region Matching: Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key).", "type": "object" }, "keyAlgorithm": { - "description": "Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If unspecified, this will default to ECDSA_P256.", + "description": "Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If not specified, this will default to ECDSA_P256.", "enum": [ "KEY_ALGORITHM_UNSPECIFIED", "RSA_2048", @@ -4337,12 +4337,12 @@ "type": "string" }, "lifetime": { - "description": "Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 10 hours - 30 days. If unspecified, this will be defaulted to 24 hours.", + "description": "Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 10 hours and 30 days. If not specified, this will be defaulted to 24 hours.", "format": "google-duration", "type": "string" }, "rotationWindowPercentage": { - "description": "Optional. Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between 10 - 80. If unspecified, this will be defaulted to 50.", + "description": "Optional. Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between 10 and 80. If not specified, this will be defaulted to 50.", "format": "int32", "type": "integer" } @@ -4357,7 +4357,7 @@ "additionalProperties": { "$ref": "TrustStore" }, - "description": "Optional. Maps specific trust domains (e.g., \"example.com\") to their corresponding TrustStore objects, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the Trust Bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools.", + "description": "Optional. Maps specific trust domains (e.g., \"example.com\") to their corresponding TrustStore, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the trust bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools.", "type": "object" } }, @@ -4886,7 +4886,7 @@ "type": "array" }, "issuerUri": { - "description": "Required. The OIDC issuer URL. Must be an HTTPS endpoint. Used per OpenID Connect Discovery 1.0 spec to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'.", + "description": "Required. The OIDC issuer URL. Must be an HTTPS endpoint. Per OpenID Connect Discovery 1.0 spec, the OIDC issuer URL is used to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'.", "type": "string" }, "jwksJson": { @@ -5157,7 +5157,7 @@ "id": "QueryGrantableRolesRequest", "properties": { "fullResourceName": { - "description": "Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.", + "description": "Required. Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.", "type": "string" }, "pageSize": { @@ -5681,18 +5681,18 @@ "type": "object" }, "TrustStore": { - "description": "Trust store that contains trust anchors and optional intermediate CAs used in PKI to build trust chain and verify client's identity.", + "description": "Trust store that contains trust anchors and optional intermediate CAs used in PKI to build trust chain and verify a client's identity.", "id": "TrustStore", "properties": { "intermediateCas": { - "description": "Optional. Set of intermediate CA certificates used for building the trust chain to trust anchor. IMPORTANT: * Intermediate CAs are only supported when configuring x509 federation.", + "description": "Optional. Set of intermediate CA certificates used for building the trust chain to the trust anchor. Important: Intermediate CAs are only supported for X.509 federation.", "items": { "$ref": "IntermediateCA" }, "type": "array" }, "trustAnchors": { - "description": "Required. List of Trust Anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be chained up to one of the trust anchors here.", + "description": "Required. List of trust anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be in the trust chain of one of the trust anchors here.", "items": { "$ref": "TrustAnchor" }, @@ -5877,6 +5877,10 @@ "description": "Optional. A user-specified description of the provider. Cannot exceed 256 characters.", "type": "string" }, + "detailedAuditLogging": { + "description": "Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false.", + "type": "boolean" + }, "disabled": { "description": "Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.", "type": "boolean" @@ -6260,7 +6264,7 @@ "properties": { "trustStore": { "$ref": "TrustStore", - "description": "Required. A Trust store, use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the x509 guidelines to define those PEM encoded certs. Only 1 trust store is currently supported." + "description": "Required. A TrustStore. Use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the X.509 guidelines to define those PEM encoded certs. Only one trust store is currently supported." } }, "type": "object" diff --git a/discovery/iam-v2.json b/discovery/iam-v2.json index dfcc4a8569..8bcfab1652 100644 --- a/discovery/iam-v2.json +++ b/discovery/iam-v2.json @@ -293,7 +293,7 @@ } } }, - "revision": "20250213", + "revision": "20250502", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { @@ -483,7 +483,7 @@ "type": "array" }, "deniedPrincipals": { - "description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", + "description": " The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, diff --git a/discovery/iam-v2beta.json b/discovery/iam-v2beta.json index f1cbadc2fe..2e39ff0d4f 100644 --- a/discovery/iam-v2beta.json +++ b/discovery/iam-v2beta.json @@ -293,7 +293,7 @@ } } }, - "revision": "20250213", + "revision": "20250502", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { @@ -483,7 +483,7 @@ "type": "array" }, "deniedPrincipals": { - "description": "The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", + "description": " The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "items": { "type": "string" }, diff --git a/discovery/index.json b/discovery/index.json index e980eb610e..71a774c034 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -570,6 +570,21 @@ "title": "Apigee Registry API", "version": "v1" }, + { + "description": "", + "discoveryRestUrl": "https://apihub.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "apihub:v1", + "kind": "discovery#directoryItem", + "name": "apihub", + "preferred": true, + "title": "API hub API", + "version": "v1" + }, { "description": "Manages the API keys associated with developer projects.", "discoveryRestUrl": "https://apikeys.googleapis.com/$discovery/rest?version=v2", @@ -3140,6 +3155,36 @@ "title": "Firebase App Distribution API", "version": "v1" }, + { + "description": "Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub integration, and integration with other Firebase products. You can use this API to intervene in the Firebase App Hosting build process and add custom functionality not supported in our default Console & CLI flows, including triggering builds from external CI/CD workflows or deploying from pre-built container images.", + "discoveryRestUrl": "https://firebaseapphosting.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://firebase.google.com/docs/app-hosting", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "firebaseapphosting:v1beta", + "kind": "discovery#directoryItem", + "name": "firebaseapphosting", + "preferred": false, + "title": "Firebase App Hosting API", + "version": "v1beta" + }, + { + "description": "Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub integration, and integration with other Firebase products. You can use this API to intervene in the Firebase App Hosting build process and add custom functionality not supported in our default Console & CLI flows, including triggering builds from external CI/CD workflows or deploying from pre-built container images.", + "discoveryRestUrl": "https://firebaseapphosting.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/app-hosting", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "firebaseapphosting:v1", + "kind": "discovery#directoryItem", + "name": "firebaseapphosting", + "preferred": true, + "title": "Firebase App Hosting API", + "version": "v1" + }, { "description": "The Firebase Realtime Database API enables programmatic provisioning and management of Realtime Database instances.", "discoveryRestUrl": "https://firebasedatabase.googleapis.com/$discovery/rest?version=v1beta", @@ -4280,6 +4325,21 @@ "title": "Merchant API", "version": "inventories_v1beta" }, + { + "description": "Programmatically manage your Merchant Center Accounts.", + "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=issueresolution_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "merchantapi:issueresolution_v1beta", + "kind": "discovery#directoryItem", + "name": "merchantapi", + "preferred": false, + "title": "Merchant API", + "version": "issueresolution_v1beta" + }, { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=lfp_v1beta", @@ -4310,6 +4370,21 @@ "title": "Merchant API", "version": "notifications_v1beta" }, + { + "description": "Programmatically manage your Merchant Center Accounts.", + "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=ordertracking_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "merchantapi:ordertracking_v1beta", + "kind": "discovery#directoryItem", + "name": "merchantapi", + "preferred": false, + "title": "Merchant API", + "version": "ordertracking_v1beta" + }, { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=products_v1beta", diff --git a/discovery/integrations-v1.json b/discovery/integrations-v1.json index aef0956e7a..b071b60ae7 100644 --- a/discovery/integrations-v1.json +++ b/discovery/integrations-v1.json @@ -4810,7 +4810,7 @@ } } }, - "revision": "20250427", + "revision": "20250506", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -9461,18 +9461,18 @@ "id": "GoogleCloudConnectorsV1AuthConfig", "properties": { "additionalVariables": { - "description": "List containing additional auth configs.", + "description": "Optional. List containing additional auth configs.", "items": { "$ref": "GoogleCloudConnectorsV1ConfigVariable" }, "type": "array" }, "authKey": { - "description": "Identifier key for auth config", + "description": "Optional. Identifier key for auth config", "type": "string" }, "authType": { - "description": "The type of authentication configured.", + "description": "Optional. The type of authentication configured.", "enum": [ "AUTH_TYPE_UNSPECIFIED", "USER_PASSWORD", @@ -9527,35 +9527,35 @@ "id": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow", "properties": { "authCode": { - "description": "Authorization code to be exchanged for access and refresh tokens.", + "description": "Optional. Authorization code to be exchanged for access and refresh tokens.", "type": "string" }, "authUri": { - "description": "Auth URL for Authorization Code Flow", + "description": "Optional. Auth URL for Authorization Code Flow", "type": "string" }, "clientId": { - "description": "Client ID for user-provided OAuth app.", + "description": "Optional. Client ID for user-provided OAuth app.", "type": "string" }, "clientSecret": { "$ref": "GoogleCloudConnectorsV1Secret", - "description": "Client secret for user-provided OAuth app." + "description": "Optional. Client secret for user-provided OAuth app." }, "enablePkce": { - "description": "Whether to enable PKCE when the user performs the auth code flow.", + "description": "Optional. Whether to enable PKCE when the user performs the auth code flow.", "type": "boolean" }, "pkceVerifier": { - "description": "PKCE verifier to be used during the auth code exchange.", + "description": "Optional. PKCE verifier to be used during the auth code exchange.", "type": "string" }, "redirectUri": { - "description": "Redirect URI to be provided during the auth code exchange.", + "description": "Optional. Redirect URI to be provided during the auth code exchange.", "type": "string" }, "scopes": { - "description": "Scopes the connection will request when the user performs the auth code flow.", + "description": "Optional. Scopes the connection will request when the user performs the auth code flow.", "items": { "type": "string" }, @@ -9591,12 +9591,12 @@ "id": "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials", "properties": { "clientId": { - "description": "The client identifier.", + "description": "Optional. The client identifier.", "type": "string" }, "clientSecret": { "$ref": "GoogleCloudConnectorsV1Secret", - "description": "Secret version reference containing the client secret." + "description": "Optional. Secret version reference containing the client secret." } }, "type": "object" @@ -9607,11 +9607,11 @@ "properties": { "clientKey": { "$ref": "GoogleCloudConnectorsV1Secret", - "description": "Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`." + "description": "Optional. Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`." }, "jwtClaims": { "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims", - "description": "JwtClaims providers fields to generate the token." + "description": "Optional. JwtClaims providers fields to generate the token." } }, "type": "object" @@ -9621,15 +9621,15 @@ "id": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims", "properties": { "audience": { - "description": "Value for the \"aud\" claim.", + "description": "Optional. Value for the \"aud\" claim.", "type": "string" }, "issuer": { - "description": "Value for the \"iss\" claim.", + "description": "Optional. Value for the \"iss\" claim.", "type": "string" }, "subject": { - "description": "Value for the \"sub\" claim.", + "description": "Optional. Value for the \"sub\" claim.", "type": "string" } }, @@ -9640,19 +9640,19 @@ "id": "GoogleCloudConnectorsV1AuthConfigSshPublicKey", "properties": { "certType": { - "description": "Format of SSH Client cert.", + "description": "Optional. Format of SSH Client cert.", "type": "string" }, "sshClientCert": { "$ref": "GoogleCloudConnectorsV1Secret", - "description": "SSH Client Cert. It should contain both public and private key." + "description": "Optional. SSH Client Cert. It should contain both public and private key." }, "sshClientCertPass": { "$ref": "GoogleCloudConnectorsV1Secret", - "description": "Password (passphrase) for ssh client certificate if it has one." + "description": "Optional. Password (passphrase) for ssh client certificate if it has one." }, "username": { - "description": "The user account used to authenticate.", + "description": "Optional. The user account used to authenticate.", "type": "string" } }, @@ -9664,10 +9664,10 @@ "properties": { "password": { "$ref": "GoogleCloudConnectorsV1Secret", - "description": "Secret version reference containing the password." + "description": "Optional. Secret version reference containing the password." }, "username": { - "description": "Username.", + "description": "Optional. Username.", "type": "string" } }, @@ -9713,7 +9713,7 @@ "type": "string" }, "key": { - "description": "Key of the config variable.", + "description": "Optional. Key of the config variable.", "type": "string" }, "secretValue": { @@ -9813,6 +9813,10 @@ "readOnly": true, "type": "string" }, + "euaOauthAuthConfig": { + "$ref": "GoogleCloudConnectorsV1AuthConfig", + "description": "Optional. Additional Oauth2.0 Auth config for EUA. If the connection is configured using non-OAuth authentication but OAuth needs to be used for EUA, this field can be populated with the OAuth config. This should be a OAuth2AuthCodeFlow Auth type only." + }, "eventingConfig": { "$ref": "GoogleCloudConnectorsV1EventingConfig", "description": "Optional. Eventing config of a connection" @@ -9836,6 +9840,10 @@ "description": "Output only. Eventing Runtime Data.", "readOnly": true }, + "fallbackOnAdminCredentials": { + "description": "Optional. Fallback on admin credentials for the connection. If this both auth_override_enabled and fallback_on_admin_credentials are set to true, the connection will use the admin credentials if the dynamic auth header is not present during auth override.", + "type": "boolean" + }, "host": { "description": "Output only. The name of the Hostname of the Service Directory service with TLS.", "readOnly": true, @@ -10115,7 +10123,7 @@ "id": "GoogleCloudConnectorsV1EncryptionKey", "properties": { "kmsKeyName": { - "description": "The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.", + "description": "Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.", "type": "string" }, "type": { @@ -10358,11 +10366,11 @@ "id": "GoogleCloudConnectorsV1LockConfig", "properties": { "locked": { - "description": "Indicates whether or not the connection is locked.", + "description": "Optional. Indicates whether or not the connection is locked.", "type": "boolean" }, "reason": { - "description": "Describes why a connection is locked.", + "description": "Optional. Describes why a connection is locked.", "type": "string" } }, @@ -10373,7 +10381,7 @@ "id": "GoogleCloudConnectorsV1LogConfig", "properties": { "enabled": { - "description": "Enabled represents whether logging is enabled or not for a connection.", + "description": "Optional. Enabled represents whether logging is enabled or not for a connection.", "type": "boolean" }, "level": { @@ -10400,12 +10408,12 @@ "id": "GoogleCloudConnectorsV1NodeConfig", "properties": { "maxNodeCount": { - "description": "Maximum number of nodes in the runtime nodes.", + "description": "Optional. Maximum number of nodes in the runtime nodes.", "format": "int32", "type": "integer" }, "minNodeCount": { - "description": "Minimum number of nodes in the runtime nodes.", + "description": "Optional. Minimum number of nodes in the runtime nodes.", "format": "int32", "type": "integer" } @@ -10451,7 +10459,7 @@ "id": "GoogleCloudConnectorsV1Secret", "properties": { "secretVersion": { - "description": "The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.", + "description": "Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.", "type": "string" } }, diff --git a/discovery/kmsinventory-v1.json b/discovery/kmsinventory-v1.json index cdc9f71834..cfc61f5911 100644 --- a/discovery/kmsinventory-v1.json +++ b/discovery/kmsinventory-v1.json @@ -242,7 +242,7 @@ } } }, - "revision": "20250302", + "revision": "20250518", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { @@ -659,7 +659,7 @@ "This version is still being generated. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.", "This version may be used for cryptographic operations.", "This version may not be used, but the key material is still available, and the version can be placed back into the ENABLED state.", - "This key material of this version is destroyed and no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion.", + "The key material of this version is destroyed and no longer stored. This version may only become ENABLED again if this version is reimport_eligible and the original key material is reimported with a call to KeyManagementService.ImportCryptoKeyVersion.", "This version is scheduled for destruction, and will be destroyed soon. Call RestoreCryptoKeyVersion to put it back into the DISABLED state.", "This version is still being imported. It may not be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark this version ENABLED as soon as the version is ready.", "This version was not imported successfully. It may not be used, enabled, disabled, or destroyed. The submitted key material has been discarded. Additional details can be found in CryptoKeyVersion.import_failure_reason.", diff --git a/discovery/language-v1.json b/discovery/language-v1.json index 841164fdbe..44873926ad 100644 --- a/discovery/language-v1.json +++ b/discovery/language-v1.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250420", + "revision": "20250518", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -691,6 +691,7 @@ "A2", "A3", "A4", + "A4X", "C2", "C2D", "CUSTOM", @@ -709,6 +710,7 @@ "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", "COMPUTE_OPTIMIZED", "", "", @@ -766,6 +768,7 @@ "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", "A4_HIGHGPU_8G", + "A4X_HIGHGPU_4G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1058,6 +1061,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1434,6 +1438,7 @@ "NVIDIA_TESLA_A100", "NVIDIA_A100_80GB", "NVIDIA_B200", + "NVIDIA_GB200", "NVIDIA_TESLA_K80", "NVIDIA_L4", "NVIDIA_TESLA_P100", @@ -1457,6 +1462,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1503,6 +1509,7 @@ "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", "A4_HIGHGPU_8G", + "A4X_HIGHGPU_4G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1795,6 +1802,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2193,6 +2201,7 @@ "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", "A4_HIGHGPU_8G", + "A4X_HIGHGPU_4G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2485,6 +2494,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2501,6 +2511,7 @@ "A2", "A3", "A4", + "A4X", "C2", "C2D", "CUSTOM", @@ -2519,6 +2530,7 @@ "", "", "", + "", "COMPUTE_OPTIMIZED", "", "", @@ -3670,6 +3682,7 @@ "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB", "NVIDIA_B200", + "NVIDIA_GB200", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3689,6 +3702,7 @@ "Nvidia H100 80Gb GPU.", "Nvidia H200 141Gb GPU.", "Nvidia B200 GPU.", + "Nvidia GB200 GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/language-v1beta2.json b/discovery/language-v1beta2.json index 22fb3debd1..a6cb80ad3e 100644 --- a/discovery/language-v1beta2.json +++ b/discovery/language-v1beta2.json @@ -246,7 +246,7 @@ } } }, - "revision": "20250420", + "revision": "20250518", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -691,6 +691,7 @@ "A2", "A3", "A4", + "A4X", "C2", "C2D", "CUSTOM", @@ -709,6 +710,7 @@ "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", "COMPUTE_OPTIMIZED", "", "", @@ -766,6 +768,7 @@ "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", "A4_HIGHGPU_8G", + "A4X_HIGHGPU_4G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1058,6 +1061,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1452,6 +1456,7 @@ "NVIDIA_TESLA_A100", "NVIDIA_A100_80GB", "NVIDIA_B200", + "NVIDIA_GB200", "NVIDIA_TESLA_K80", "NVIDIA_L4", "NVIDIA_TESLA_P100", @@ -1475,6 +1480,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1521,6 +1527,7 @@ "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", "A4_HIGHGPU_8G", + "A4X_HIGHGPU_4G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1813,6 +1820,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2211,6 +2219,7 @@ "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", "A4_HIGHGPU_8G", + "A4X_HIGHGPU_4G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2503,6 +2512,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2519,6 +2529,7 @@ "A2", "A3", "A4", + "A4X", "C2", "C2D", "CUSTOM", @@ -2537,6 +2548,7 @@ "", "", "", + "", "COMPUTE_OPTIMIZED", "", "", @@ -3688,6 +3700,7 @@ "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB", "NVIDIA_B200", + "NVIDIA_GB200", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3707,6 +3720,7 @@ "Nvidia H100 80Gb GPU.", "Nvidia H200 141Gb GPU.", "Nvidia B200 GPU.", + "Nvidia GB200 GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/language-v2.json b/discovery/language-v2.json index 04c4d6d850..e3d00fd322 100644 --- a/discovery/language-v2.json +++ b/discovery/language-v2.json @@ -208,7 +208,7 @@ } } }, - "revision": "20250420", + "revision": "20250518", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -516,6 +516,7 @@ "A2", "A3", "A4", + "A4X", "C2", "C2D", "CUSTOM", @@ -534,6 +535,7 @@ "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", + "GPU-based machine, skip quota reporting.", "COMPUTE_OPTIMIZED", "", "", @@ -591,6 +593,7 @@ "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", "A4_HIGHGPU_8G", + "A4X_HIGHGPU_4G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -883,6 +886,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1073,6 +1077,7 @@ "NVIDIA_TESLA_A100", "NVIDIA_A100_80GB", "NVIDIA_B200", + "NVIDIA_GB200", "NVIDIA_TESLA_K80", "NVIDIA_L4", "NVIDIA_TESLA_P100", @@ -1096,6 +1101,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1142,6 +1148,7 @@ "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", "A4_HIGHGPU_8G", + "A4X_HIGHGPU_4G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1434,6 +1441,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1587,6 +1595,7 @@ "A3_ULTRAGPU_8G", "A3_EDGEGPU_8G", "A4_HIGHGPU_8G", + "A4X_HIGHGPU_4G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1879,6 +1888,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1895,6 +1905,7 @@ "A2", "A3", "A4", + "A4X", "C2", "C2D", "CUSTOM", @@ -1913,6 +1924,7 @@ "", "", "", + "", "COMPUTE_OPTIMIZED", "", "", @@ -3041,6 +3053,7 @@ "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB", "NVIDIA_B200", + "NVIDIA_GB200", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3060,6 +3073,7 @@ "Nvidia H100 80Gb GPU.", "Nvidia H200 141Gb GPU.", "Nvidia B200 GPU.", + "Nvidia GB200 GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/managedkafka-v1.json b/discovery/managedkafka-v1.json index e7e17f4a98..37afdd9642 100644 --- a/discovery/managedkafka-v1.json +++ b/discovery/managedkafka-v1.json @@ -1436,13 +1436,1440 @@ ] } } + }, + "schemaRegistries": { + "methods": { + "create": { + "description": "Create a schema registry instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.schemaRegistries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent whose schema registry instance is to be created. Structured like: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemaRegistries", + "request": { + "$ref": "CreateSchemaRegistryRequest" + }, + "response": { + "$ref": "SchemaRegistry" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a schema registry instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.schemaRegistries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the schema registry instance to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get the schema registry instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the schema registry instance to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SchemaRegistry" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List schema registries.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent whose schema registry instances are to be listed. Structured like: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemaRegistries", + "response": { + "$ref": "ListSchemaRegistriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "compatibility": { + "methods": { + "checkCompatibility": { + "description": "Check compatibility of a schema with all versions or a specific version of a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/compatibility/{compatibilityId}", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.schemaRegistries.compatibility.checkCompatibility", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource to check compatibility for. The format is either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/*/versions: Check compatibility with one or more versions of the specified subject. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/{subject}/versions/{version}: Check compatibility with a specific version of the subject.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/compatibility/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "CheckCompatibilityRequest" + }, + "response": { + "$ref": "CheckCompatibilityResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "config": { + "methods": { + "delete": { + "description": "Delete schema config for a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/config/{configId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.schemaRegistries.config.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of subject to delete the config for. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/config/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SchemaConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get schema config at global level or for a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/config/{configId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.config.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "defaultToGlobal": { + "description": "Optional. If true, the config will fall back to the config at the global level if no subject level config is found.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The resource name to get the config for. It can be either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Get config at global level. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Get config for a specific subject.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/config/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SchemaConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/config/{configId}", + "httpMethod": "PUT", + "id": "managedkafka.projects.locations.schemaRegistries.config.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name to update the config for. It can be either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Update config at global level. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Update config for a specific subject.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/config/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "UpdateSchemaConfigRequest" + }, + "response": { + "$ref": "SchemaConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "contexts": { + "methods": { + "get": { + "description": "Get the context.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the context to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Context" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List contexts for a schema registry.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent of the contexts. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/contexts", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "compatibility": { + "methods": { + "checkCompatibility": { + "description": "Check compatibility of a schema with all versions or a specific version of a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/compatibility/{compatibilityId}", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.compatibility.checkCompatibility", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource to check compatibility for. The format is either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/*/versions: Check compatibility with one or more versions of the specified subject. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/{subject}/versions/{version}: Check compatibility with a specific version of the subject.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/compatibility/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "CheckCompatibilityRequest" + }, + "response": { + "$ref": "CheckCompatibilityResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "config": { + "methods": { + "delete": { + "description": "Delete schema config for a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/config/{configId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.config.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of subject to delete the config for. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/config/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SchemaConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get schema config at global level or for a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/config/{configId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.config.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "defaultToGlobal": { + "description": "Optional. If true, the config will fall back to the config at the global level if no subject level config is found.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The resource name to get the config for. It can be either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Get config at global level. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Get config for a specific subject.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/config/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SchemaConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/config/{configId}", + "httpMethod": "PUT", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.config.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name to update the config for. It can be either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Update config at global level. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Update config for a specific subject.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/config/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "UpdateSchemaConfigRequest" + }, + "response": { + "$ref": "SchemaConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "mode": { + "methods": { + "get": { + "description": "Get mode at global level or for a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/mode/{modeId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.mode.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/mode/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SchemaMode" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Update mode at global level or for a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/mode/{modeId}", + "httpMethod": "PUT", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.mode.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/mode/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "UpdateSchemaModeRequest" + }, + "response": { + "$ref": "SchemaMode" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "schemas": { + "methods": { + "get": { + "description": "Get the schema for the given schema id.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.schemas.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the schema to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/schemas/.*$", + "required": true, + "type": "string" + }, + "subject": { + "description": "Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Schema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getSchema": { + "description": "Get the schema string for the given schema id. The response will be the schema string.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}/schema", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.schemas.getSchema", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the schema to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/schemas/.*$", + "required": true, + "type": "string" + }, + "subject": { + "description": "Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/schema", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "subjects": { + "methods": { + "list": { + "description": "List subjects which reference a particular schema id. The response will be an array of subject names.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}/subjects", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.schemas.subjects.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, the response will include soft-deleted subjects. The default is false.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The schema resource whose associated subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/schemas/.*$", + "required": true, + "type": "string" + }, + "subject": { + "description": "Optional. The subject to filter the subjects by.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/subjects", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "types": { + "methods": { + "list": { + "description": "List the supported schema types. The response will be an array of schema types.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/types", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.schemas.types.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent schema registry whose schema types are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemas/types", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "versions": { + "methods": { + "list": { + "description": "List the schema versions for the given schema id. The response will be an array of subject-version pairs as: [{\"subject\":\"subject1\", \"version\":1}, {\"subject\":\"subject2\", \"version\":2}].", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}/versions", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.schemas.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The schema whose schema versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/schemas/.*$", + "required": true, + "type": "string" + }, + "subject": { + "description": "Optional. The subject to filter the subjects by.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/versions", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "subjects": { + "methods": { + "delete": { + "description": "Delete a subject. The response will be an array of versions of the deleted subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.subjects.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the subject to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+$", + "required": true, + "type": "string" + }, + "permanent": { + "description": "Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft-deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List subjects in the schema registry. The response will be an array of subject names.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.subjects.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, the response will include soft-deleted subjects. The default is false.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The parent schema registry/context whose subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + }, + "subjectPrefix": { + "description": "Optional. The context to filter the subjects by, in the format of `:.{context}:`. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/subjects", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "lookupVersion": { + "description": "Lookup a schema under the specified subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.subjects.lookupVersion", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The subject to lookup the schema in. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}", + "request": { + "$ref": "LookupVersionRequest" + }, + "response": { + "$ref": "SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "versions": { + "methods": { + "create": { + "description": "Register a new version under a given subject with the given schema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The subject to create the version for. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/versions", + "request": { + "$ref": "CreateVersionRequest" + }, + "response": { + "$ref": "CreateVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a version of a subject. The response will be the deleted version id.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the subject version to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "permanent": { + "description": "Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a versioned schema (schema with subject/version) of a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the subject to return versions. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getSchema": { + "description": "Get the schema string only for a version of a subject. The response will be the schema string.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}/schema", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.getSchema", + "parameterOrder": [ + "name" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the subject to return versions. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/schema", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Get all versions of a subject. The response will be an array of versions of the subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The subject whose versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/versions", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "referencedby": { + "methods": { + "list": { + "description": "Get a list of IDs of schemas that reference the schema with the given subject and version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}/referencedby", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.referencedby.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The version to list referenced by. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/referencedby", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, + "mode": { + "methods": { + "get": { + "description": "Get mode at global level or for a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/mode/{modeId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.mode.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/mode/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SchemaMode" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Update mode at global level or for a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/mode/{modeId}", + "httpMethod": "PUT", + "id": "managedkafka.projects.locations.schemaRegistries.mode.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/mode/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "UpdateSchemaModeRequest" + }, + "response": { + "$ref": "SchemaMode" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "schemas": { + "methods": { + "get": { + "description": "Get the schema for the given schema id.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.schemas.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the schema to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/schemas/.*$", + "required": true, + "type": "string" + }, + "subject": { + "description": "Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Schema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getSchema": { + "description": "Get the schema string for the given schema id. The response will be the schema string.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}/schema", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.schemas.getSchema", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the schema to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/schemas/.*$", + "required": true, + "type": "string" + }, + "subject": { + "description": "Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/schema", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "subjects": { + "methods": { + "list": { + "description": "List subjects which reference a particular schema id. The response will be an array of subject names.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}/subjects", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.schemas.subjects.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, the response will include soft-deleted subjects. The default is false.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The schema resource whose associated subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/schemas/.*$", + "required": true, + "type": "string" + }, + "subject": { + "description": "Optional. The subject to filter the subjects by.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/subjects", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "types": { + "methods": { + "list": { + "description": "List the supported schema types. The response will be an array of schema types.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/types", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.schemas.types.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent schema registry whose schema types are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemas/types", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "versions": { + "methods": { + "list": { + "description": "List the schema versions for the given schema id. The response will be an array of subject-version pairs as: [{\"subject\":\"subject1\", \"version\":1}, {\"subject\":\"subject2\", \"version\":2}].", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}/versions", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.schemas.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The schema whose schema versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/schemas/.*$", + "required": true, + "type": "string" + }, + "subject": { + "description": "Optional. The subject to filter the subjects by.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/versions", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "subjects": { + "methods": { + "delete": { + "description": "Delete a subject. The response will be an array of versions of the deleted subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.schemaRegistries.subjects.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the subject to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+$", + "required": true, + "type": "string" + }, + "permanent": { + "description": "Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft-deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List subjects in the schema registry. The response will be an array of subject names.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.subjects.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, the response will include soft-deleted subjects. The default is false.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The parent schema registry/context whose subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$", + "required": true, + "type": "string" + }, + "subjectPrefix": { + "description": "Optional. The context to filter the subjects by, in the format of `:.{context}:`. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/subjects", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "lookupVersion": { + "description": "Lookup a schema under the specified subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.schemaRegistries.subjects.lookupVersion", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The subject to lookup the schema in. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}", + "request": { + "$ref": "LookupVersionRequest" + }, + "response": { + "$ref": "SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "versions": { + "methods": { + "create": { + "description": "Register a new version under a given subject with the given schema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions", + "httpMethod": "POST", + "id": "managedkafka.projects.locations.schemaRegistries.subjects.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The subject to create the version for. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/versions", + "request": { + "$ref": "CreateVersionRequest" + }, + "response": { + "$ref": "CreateVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a version of a subject. The response will be the deleted version id.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}", + "httpMethod": "DELETE", + "id": "managedkafka.projects.locations.schemaRegistries.subjects.versions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the subject version to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "permanent": { + "description": "Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a versioned schema (schema with subject/version) of a subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.subjects.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the subject to return versions. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getSchema": { + "description": "Get the schema string only for a version of a subject. The response will be the schema string.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}/schema", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.subjects.versions.getSchema", + "parameterOrder": [ + "name" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the subject to return versions. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/schema", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Get all versions of a subject. The response will be an array of versions of the subject.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.subjects.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deleted": { + "description": "Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. The subject whose versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/versions", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "referencedby": { + "methods": { + "list": { + "description": "Get a list of IDs of schemas that reference the schema with the given subject and version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}/referencedby", + "httpMethod": "GET", + "id": "managedkafka.projects.locations.schemaRegistries.subjects.versions.referencedby.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The version to list referenced by. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/referencedby", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } } } } } } }, - "revision": "20250414", + "revision": "20250508", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -1557,6 +2984,62 @@ }, "type": "object" }, + "CheckCompatibilityRequest": { + "description": "Request for CheckCompatibility.", + "id": "CheckCompatibilityRequest", + "properties": { + "references": { + "description": "Optional. The schema references used by the schema.", + "items": { + "$ref": "SchemaReference" + }, + "type": "array" + }, + "schema": { + "description": "Required. The schema payload", + "type": "string" + }, + "schemaType": { + "description": "Optional. The schema type of the schema.", + "enum": [ + "SCHEMA_TYPE_UNSPECIFIED", + "AVRO", + "JSON", + "PROTOBUF" + ], + "enumDescriptions": [ + "No schema type. The default will be AVRO.", + "Avro schema type.", + "JSON schema type.", + "Protobuf schema type." + ], + "type": "string" + }, + "verbose": { + "description": "Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.", + "type": "boolean" + } + }, + "type": "object" + }, + "CheckCompatibilityResponse": { + "description": "Response for CheckCompatibility.", + "id": "CheckCompatibilityResponse", + "properties": { + "is_compatible": { + "description": "The compatibility check result. If true, the schema is compatible with the resource.", + "type": "boolean" + }, + "messages": { + "description": "Failure reasons if verbose = true.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Cluster": { "description": "An Apache Kafka cluster deployed in a location.", "id": "Cluster", @@ -1842,6 +3325,99 @@ }, "type": "object" }, + "Context": { + "description": "Context represents an independent schema grouping in a schema registry instance.", + "id": "Context", + "properties": { + "name": { + "description": "Identifier. The name of the context. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}` The context name {context} can contain the following: * Up to 255 characters. * Allowed characters: letters (uppercase or lowercase), numbers, and the following special characters: `.`, `-`, `_`, `+`, `%`, and `~`.", + "type": "string" + }, + "subjects": { + "description": "Optional. The subjects of the context.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CreateSchemaRegistryRequest": { + "description": "Request to create a schema registry instance.", + "id": "CreateSchemaRegistryRequest", + "properties": { + "schemaRegistry": { + "$ref": "SchemaRegistry", + "description": "Required. The schema registry instance to create. The name field is ignored." + }, + "schemaRegistryId": { + "description": "Required. The schema registry instance ID to use for this schema registry. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (-). The maximum length is 63 characters. The ID must not start with a number.", + "type": "string" + } + }, + "type": "object" + }, + "CreateVersionRequest": { + "description": "Request for CreateVersion.", + "id": "CreateVersionRequest", + "properties": { + "id": { + "description": "Optional. The schema ID of the schema. If not specified, the schema ID will be generated by the server. If the schema ID is specified, it must not be used by an existing schema that is different from the schema to be created.", + "format": "int32", + "type": "integer" + }, + "normalize": { + "description": "Optional. If true, the schema will be normalized before being stored. The default is false.", + "type": "boolean" + }, + "references": { + "description": "Optional. The schema references used by the schema.", + "items": { + "$ref": "SchemaReference" + }, + "type": "array" + }, + "schema": { + "description": "Required. The schema payload", + "type": "string" + }, + "schemaType": { + "description": "Optional. The type of the schema. It is optional. If not specified, the schema type will be AVRO.", + "enum": [ + "SCHEMA_TYPE_UNSPECIFIED", + "AVRO", + "JSON", + "PROTOBUF" + ], + "enumDescriptions": [ + "No schema type. The default will be AVRO.", + "Avro schema type.", + "JSON schema type.", + "Protobuf schema type." + ], + "type": "string" + }, + "version": { + "description": "Optional. The version to create. It is optional. If not specified, the version will be created with the max version ID of the subject increased by 1. If the version ID is specified, it will be used as the new version ID and must not be used by an existing version of the subject.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CreateVersionResponse": { + "description": "Response for CreateVersion.", + "id": "CreateVersionResponse", + "properties": { + "id": { + "description": "The unique identifier of the schema created.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1863,6 +3439,33 @@ }, "type": "object" }, + "HttpBody": { + "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", + "id": "HttpBody", + "properties": { + "contentType": { + "description": "The HTTP Content-Type header value specifying the content type of the body.", + "type": "string" + }, + "data": { + "description": "The HTTP request/response body as raw binary.", + "format": "byte", + "type": "string" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, "ListAclsResponse": { "description": "Response for ListAcls.", "id": "ListAclsResponse", @@ -2003,6 +3606,20 @@ }, "type": "object" }, + "ListSchemaRegistriesResponse": { + "description": "Request for ListSchemaRegistries.", + "id": "ListSchemaRegistriesResponse", + "properties": { + "schemaRegistries": { + "description": "The schema registry instances.", + "items": { + "$ref": "SchemaRegistry" + }, + "type": "array" + } + }, + "type": "object" + }, "ListTopicsResponse": { "description": "Response for ListTopics.", "id": "ListTopicsResponse", @@ -2055,6 +3672,48 @@ }, "type": "object" }, + "LookupVersionRequest": { + "description": "Request for LookupVersion.", + "id": "LookupVersionRequest", + "properties": { + "deleted": { + "description": "Optional. If true, soft-deleted versions will be included in lookup, no matter if the subject is active or soft-deleted. If false, soft-deleted versions will be excluded. The default is false.", + "type": "boolean" + }, + "normalize": { + "description": "Optional. If true, the schema will be normalized before being looked up. The default is false.", + "type": "boolean" + }, + "references": { + "description": "Optional. The schema references used by the schema.", + "items": { + "$ref": "SchemaReference" + }, + "type": "array" + }, + "schema": { + "description": "Required. The schema payload", + "type": "string" + }, + "schemaType": { + "description": "Optional. The schema type of the schema.", + "enum": [ + "SCHEMA_TYPE_UNSPECIFIED", + "AVRO", + "JSON", + "PROTOBUF" + ], + "enumDescriptions": [ + "No schema type. The default will be AVRO.", + "Avro schema type.", + "JSON schema type.", + "Protobuf schema type." + ], + "type": "string" + } + }, + "type": "object" + }, "NetworkConfig": { "description": "The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka cluster.", "id": "NetworkConfig", @@ -2217,6 +3876,187 @@ "properties": {}, "type": "object" }, + "Schema": { + "description": "Schema for a Kafka message.", + "id": "Schema", + "properties": { + "references": { + "description": "Optional. The schema references used by the schema.", + "items": { + "$ref": "SchemaReference" + }, + "type": "array" + }, + "schema": { + "description": "The schema payload.", + "type": "string" + }, + "schemaType": { + "description": "Optional. The schema type of the schema.", + "enum": [ + "SCHEMA_TYPE_UNSPECIFIED", + "AVRO", + "JSON", + "PROTOBUF" + ], + "enumDescriptions": [ + "No schema type. The default will be AVRO.", + "Avro schema type.", + "JSON schema type.", + "Protobuf schema type." + ], + "type": "string" + } + }, + "type": "object" + }, + "SchemaConfig": { + "description": "SchemaConfig represents configuration for a schema registry or a specific subject.", + "id": "SchemaConfig", + "properties": { + "alias": { + "description": "Optional. The subject to which this subject is an alias of. Only applicable for subject config.", + "type": "string" + }, + "compatibility": { + "description": "Required. The compatibility type of the schema. The default value is BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults to the global value. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.", + "enum": [ + "NONE", + "BACKWARD", + "BACKWARD_TRANSITIVE", + "FORWARD", + "FORWARD_TRANSITIVE", + "FULL", + "FULL_TRANSITIVE" + ], + "enumDescriptions": [ + "No compatibility check.", + "Backwards compatible with the most recent version.", + "Backwards compatible with all previous versions.", + "Forwards compatible with the most recent version.", + "Forwards compatible with all previous versions.", + "Backwards and forwards compatible with the most recent version.", + "Backwards and forwards compatible with all previous versions." + ], + "type": "string" + }, + "normalize": { + "description": "Optional. If true, the schema will be normalized before being stored or looked up. The default is false. If unset in a SchemaSubject-level SchemaConfig, the global value will be used. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.", + "type": "boolean" + } + }, + "type": "object" + }, + "SchemaMode": { + "description": "SchemaMode represents the mode of a schema registry or a specific subject. Four modes are supported: * NONE: This is the default mode for a subject and essentially means that the subject does not have any mode set. This means the subject will follow the schema registry's mode. * READONLY: The schema registry is in read-only mode. * READWRITE: The schema registry is in read-write mode, which allows limited write operations on the schema. * IMPORT: The schema registry is in import mode, which allows more editing operations on the schema for data importing purposes.", + "id": "SchemaMode", + "properties": { + "mode": { + "description": "Required. The mode type of a schema registry (READWRITE by default) or of a subject (NONE by default, which means use the global schema registry setting).", + "enum": [ + "NONE", + "READONLY", + "READWRITE", + "IMPORT" + ], + "enumDescriptions": [ + "No mode.", + "READONLY mode.", + "READWRITE mode.", + "IMPORT mode." + ], + "type": "string" + } + }, + "type": "object" + }, + "SchemaReference": { + "description": "SchemaReference is a reference to a schema.", + "id": "SchemaReference", + "properties": { + "name": { + "description": "Required. The name of the reference.", + "type": "string" + }, + "subject": { + "description": "Required. The subject of the reference.", + "type": "string" + }, + "version": { + "description": "Required. The version of the reference.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SchemaRegistry": { + "description": "SchemaRegistry is a schema registry instance.", + "id": "SchemaRegistry", + "properties": { + "contexts": { + "description": "Output only. The contexts of the schema registry instance.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Identifier. The name of the schema registry instance. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` The instance name {schema_registry} can contain the following: * Up to 255 characters. * Letters (uppercase or lowercase), numbers, and underscores.", + "type": "string" + } + }, + "type": "object" + }, + "SchemaVersion": { + "description": "Version of a schema.", + "id": "SchemaVersion", + "properties": { + "id": { + "description": "Required. The schema ID.", + "format": "int32", + "type": "integer" + }, + "references": { + "description": "Optional. The schema references used by the schema.", + "items": { + "$ref": "SchemaReference" + }, + "type": "array" + }, + "schema": { + "description": "Required. The schema payload.", + "type": "string" + }, + "schemaType": { + "description": "Optional. The schema type of the schema.", + "enum": [ + "SCHEMA_TYPE_UNSPECIFIED", + "AVRO", + "JSON", + "PROTOBUF" + ], + "enumDescriptions": [ + "No schema type. The default will be AVRO.", + "Avro schema type.", + "JSON schema type.", + "Protobuf schema type." + ], + "type": "string" + }, + "subject": { + "description": "Required. The subject of the version.", + "type": "string" + }, + "version": { + "description": "Required. The version ID", + "format": "int32", + "type": "integer" + } + }, + "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", @@ -2300,6 +4140,62 @@ } }, "type": "object" + }, + "UpdateSchemaConfigRequest": { + "description": "Request for updating schema config. On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig.", + "id": "UpdateSchemaConfigRequest", + "properties": { + "compatibility": { + "description": "Required. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.", + "enum": [ + "NONE", + "BACKWARD", + "BACKWARD_TRANSITIVE", + "FORWARD", + "FORWARD_TRANSITIVE", + "FULL", + "FULL_TRANSITIVE" + ], + "enumDescriptions": [ + "No compatibility check.", + "Backwards compatible with the most recent version.", + "Backwards compatible with all previous versions.", + "Forwards compatible with the most recent version.", + "Forwards compatible with all previous versions.", + "Backwards and forwards compatible with the most recent version.", + "Backwards and forwards compatible with all previous versions." + ], + "type": "string" + }, + "normalize": { + "description": "Optional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.", + "type": "boolean" + } + }, + "type": "object" + }, + "UpdateSchemaModeRequest": { + "description": "Request for updating schema registry or subject mode.", + "id": "UpdateSchemaModeRequest", + "properties": { + "mode": { + "description": "Required. The mode type.", + "enum": [ + "NONE", + "READONLY", + "READWRITE", + "IMPORT" + ], + "enumDescriptions": [ + "No mode.", + "READONLY mode.", + "READWRITE mode.", + "IMPORT mode." + ], + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/memcache-v1.json b/discovery/memcache-v1.json index 19db8617bc..366ea2d588 100644 --- a/discovery/memcache-v1.json +++ b/discovery/memcache-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", @@ -584,7 +590,7 @@ } } }, - "revision": "20250206", + "revision": "20250505", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -797,6 +803,10 @@ "description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).", "type": "string" }, + "consumerProjectNumber": { + "description": "Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required.", + "type": "string" + }, "createTime": { "description": "Output only. Timestamp when the resource was created.", "format": "google-datetime", diff --git a/discovery/memcache-v1beta2.json b/discovery/memcache-v1beta2.json index f6edbe8c52..94ca3caa1b 100644 --- a/discovery/memcache-v1beta2.json +++ b/discovery/memcache-v1beta2.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", @@ -612,7 +618,7 @@ } } }, - "revision": "20250206", + "revision": "20250505", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -843,6 +849,10 @@ "description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).", "type": "string" }, + "consumerProjectNumber": { + "description": "Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required.", + "type": "string" + }, "createTime": { "description": "Output only. Timestamp when the resource was created.", "format": "google-datetime", diff --git a/discovery/merchantapi-accounts_v1beta.json b/discovery/merchantapi-accounts_v1beta.json index 34d38e032c..0f83e9b64d 100644 --- a/discovery/merchantapi-accounts_v1beta.json +++ b/discovery/merchantapi-accounts_v1beta.json @@ -602,7 +602,7 @@ "homepage": { "methods": { "claim": { - "description": "Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain more details).", + "description": "Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message is returned: * PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account. * FAILED_PRECONDITION: - The account is not a Merchant Center account. - Merchant Center account doesn't have a homepage. - Claiming failed (in this case the error message contains more details).", "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage:claim", "httpMethod": "POST", "id": "merchantapi.accounts.homepage.claim", @@ -1123,7 +1123,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the account relationship to get.", + "description": "Required. The resource name of the account relationship to get. Format: `accounts/{account}/relationships/{relationship}`", "location": "path", "pattern": "^accounts/[^/]+/relationships/[^/]+$", "required": true, @@ -1159,7 +1159,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent account of the account relationship to filter by.", + "description": "Required. The parent account of the account relationship to filter by. Format: `accounts/{account}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -1184,7 +1184,7 @@ ], "parameters": { "name": { - "description": "Identifier. The resource name of the account relationship.", + "description": "Identifier. The resource name of the account relationship. Format: `accounts/{account}/relationships/{relationship}`", "location": "path", "pattern": "^accounts/[^/]+/relationships/[^/]+$", "required": true, @@ -1222,7 +1222,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the account service to approve.", + "description": "Required. The resource name of the account service to approve. Format: `accounts/{account}/services/{service}`", "location": "path", "pattern": "^accounts/[^/]+/services/[^/]+$", "required": true, @@ -1250,7 +1250,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the account service to get.", + "description": "Required. The resource name of the account service to get. Format: `accounts/{account}/services/{service}`", "location": "path", "pattern": "^accounts/[^/]+/services/[^/]+$", "required": true, @@ -1286,7 +1286,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent account of the account service to filter by.", + "description": "Required. The parent account of the account service to filter by. Format: `accounts/{account}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -1311,7 +1311,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the parent account for the service.", + "description": "Required. The resource name of the parent account for the service. Format: `accounts/{account}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -1339,7 +1339,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the account service to reject.", + "description": "Required. The resource name of the account service to reject. Format: `accounts/{account}/services/{service}`", "location": "path", "pattern": "^accounts/[^/]+/services/[^/]+$", "required": true, @@ -1728,7 +1728,7 @@ } } }, - "revision": "20250430", + "revision": "20250507", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfServiceResponse": { @@ -1866,7 +1866,7 @@ "type": "string" }, "name": { - "description": "Identifier. The resource name of the account relationship.", + "description": "Identifier. The resource name of the account relationship. Format: `accounts/{account}/relationships/{relationship}`", "type": "string" }, "provider": { @@ -1922,7 +1922,7 @@ "type": "string" }, "name": { - "description": "Identifier. The resource name of the account service.", + "description": "Identifier. The resource name of the account service. Format: `accounts/{account}/services/{service}`", "type": "string" }, "productsManagement": { @@ -2270,7 +2270,7 @@ "id": "ClaimHomepageRequest", "properties": { "overwrite": { - "description": "Optional. When set to `true`, this option removes any existing claim on the requested website and replaces it with a claim from the account that makes the request.", + "description": "Optional. When set to `true`, this option removes any existing claim on the requested website from any other account to the account making the request, effectively replacing the previous claim.", "type": "boolean" } }, @@ -3472,7 +3472,7 @@ "type": "object" }, "Program": { - "description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", + "description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { @@ -4195,7 +4195,7 @@ "type": "string" }, "warehouse": { - "description": "Required. Warehouse name. This should match warehouse", + "description": "Required. Warehouse name. This should match [warehouse](/merchant/api/reference/rest/accounts_v1beta/accounts.shippingSettings#warehouse)", "type": "string" } }, diff --git a/discovery/merchantapi-datasources_v1beta.json b/discovery/merchantapi-datasources_v1beta.json index cd4039ae9d..0137886b3f 100644 --- a/discovery/merchantapi-datasources_v1beta.json +++ b/discovery/merchantapi-datasources_v1beta.json @@ -110,7 +110,7 @@ "dataSources": { "methods": { "create": { - "description": "Creates the new data source configuration for the given account.", + "description": "Creates the new data source configuration for the given account. This method always creates a new data source.", "flatPath": "datasources/v1beta/accounts/{accountsId}/dataSources", "httpMethod": "POST", "id": "merchantapi.accounts.dataSources.create", @@ -321,7 +321,7 @@ } } }, - "revision": "20250430", + "revision": "20250507", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { diff --git a/discovery/merchantapi-issueresolution_v1beta.json b/discovery/merchantapi-issueresolution_v1beta.json new file mode 100644 index 0000000000..973a9bcc4d --- /dev/null +++ b/discovery/merchantapi-issueresolution_v1beta.json @@ -0,0 +1,999 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/content": { + "description": "Manage your product listings and accounts for Google Shopping" + } + } + } + }, + "basePath": "", + "baseUrl": "https://merchantapi.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Merchant", + "description": "Programmatically manage your Merchant Center Accounts.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "merchantapi:issueresolution_v1beta", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://merchantapi.mtls.googleapis.com/", + "name": "merchantapi", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "issueresolution": { + "methods": { + "renderaccountissues": { + "description": "Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.", + "flatPath": "issueresolution/v1beta/accounts/{accountsId}:renderaccountissues", + "httpMethod": "POST", + "id": "merchantapi.issueresolution.renderaccountissues", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize issue resolution content. If not set, the result will be in default language `en-US`.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The account to fetch issues for. Format: `accounts/{account}`", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + }, + "timeZone": { + "description": "Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.", + "location": "query", + "type": "string" + } + }, + "path": "issueresolution/v1beta/{+name}:renderaccountissues", + "request": { + "$ref": "RenderIssuesRequestPayload" + }, + "response": { + "$ref": "RenderAccountIssuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "renderproductissues": { + "description": "Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.", + "flatPath": "issueresolution/v1beta/accounts/{accountsId}/products/{productsId}:renderproductissues", + "httpMethod": "POST", + "id": "merchantapi.issueresolution.renderproductissues", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize an issue resolution content. If not set, the result will be in default language `en-US`.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the product to fetch issues for. Format: `accounts/{account}/products/{product}`", + "location": "path", + "pattern": "^accounts/[^/]+/products/[^/]+$", + "required": true, + "type": "string" + }, + "timeZone": { + "description": "Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.", + "location": "query", + "type": "string" + } + }, + "path": "issueresolution/v1beta/{+name}:renderproductissues", + "request": { + "$ref": "RenderIssuesRequestPayload" + }, + "response": { + "$ref": "RenderProductIssuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "triggeraction": { + "description": "Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user.", + "flatPath": "issueresolution/v1beta/accounts/{accountsId}:triggeraction", + "httpMethod": "POST", + "id": "merchantapi.issueresolution.triggeraction", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "Optional. Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) used to localize the response. If not set, the result will be in default language `en-US`.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The business's account that is triggering the action. Format: `accounts/{account}`", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "issueresolution/v1beta/{+name}:triggeraction", + "request": { + "$ref": "TriggerActionPayload" + }, + "response": { + "$ref": "TriggerActionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + } + }, + "revision": "20250505", + "rootUrl": "https://merchantapi.googleapis.com/", + "schemas": { + "Action": { + "description": "An actionable step that can be executed to solve the issue.", + "id": "Action", + "properties": { + "builtinSimpleAction": { + "$ref": "BuiltInSimpleAction", + "description": "Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available." + }, + "builtinUserInputAction": { + "$ref": "BuiltInUserInputAction", + "description": "Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the business as specified for given action. They can trigger the action only when they provided all required inputs." + }, + "buttonLabel": { + "description": "Label of the action button.", + "type": "string" + }, + "externalAction": { + "$ref": "ExternalAction", + "description": "Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the business to the external location where they can perform the action." + }, + "isAvailable": { + "description": "Controlling whether the button is active or disabled. The value is 'false' when the action was already requested or is not available. If the action is not available then a reason will be present. If (your) third-party application shows a disabled button for action that is not available, then it should also show reasons.", + "type": "boolean" + }, + "reasons": { + "description": "List of reasons why the action is not available. The list of reasons is empty if the action is available. If there is only one reason, it can be displayed next to the disabled button. If there are more reasons, all of them should be displayed, for example in a pop-up dialog.", + "items": { + "$ref": "Reason" + }, + "type": "array" + } + }, + "type": "object" + }, + "ActionFlow": { + "description": "Flow that can be selected for an action. When a business selects a flow, application should open a dialog with more information and input form.", + "id": "ActionFlow", + "properties": { + "dialogButtonLabel": { + "description": "Label for the button to trigger the action from the action dialog. For example: \"Request review\"", + "type": "string" + }, + "dialogCallout": { + "$ref": "Callout", + "description": "Important message to be highlighted in the request dialog. For example: \"You can only request a review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue and wait a few days before you can request another review.\"" + }, + "dialogMessage": { + "$ref": "TextWithTooltip", + "description": "Message displayed in the request dialog. For example: \"Make sure you've fixed all your country-specific issues. If not, you may have to wait 7 days to request another review\". There may be an more information to be shown in a tooltip." + }, + "dialogTitle": { + "description": "Title of the request dialog. For example: \"Before you request a review\"", + "type": "string" + }, + "id": { + "description": "Not for display but need to be sent back for the selected action flow.", + "type": "string" + }, + "inputs": { + "description": "A list of input fields.", + "items": { + "$ref": "InputField" + }, + "type": "array" + }, + "label": { + "description": "Text value describing the intent for the action flow. It can be used as an input label if business needs to pick one of multiple flows. For example: \"I disagree with the issue\"", + "type": "string" + } + }, + "type": "object" + }, + "ActionInput": { + "description": "Input provided by the business.", + "id": "ActionInput", + "properties": { + "actionFlowId": { + "description": "Required. Id of the selected action flow.", + "type": "string" + }, + "inputValues": { + "description": "Required. Values for input fields.", + "items": { + "$ref": "InputValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdditionalContent": { + "description": "Long text from external source.", + "id": "AdditionalContent", + "properties": { + "paragraphs": { + "description": "Long text organized into paragraphs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Title of the additional content;", + "type": "string" + } + }, + "type": "object" + }, + "Breakdown": { + "description": "A detailed impact breakdown for a group of regions where the impact of the issue on different shopping destinations is the same.", + "id": "Breakdown", + "properties": { + "details": { + "description": "Human readable, localized description of issue's effect on different targets. Should be rendered as a list. For example: * \"Products not showing in ads\" * \"Products not showing organically\"", + "items": { + "type": "string" + }, + "type": "array" + }, + "regions": { + "description": "Lists of regions. Should be rendered as a title for this group of details. The full list should be shown to the business. If the list is too long, it is recommended to make it expandable.", + "items": { + "$ref": "Region" + }, + "type": "array" + } + }, + "type": "object" + }, + "BuiltInSimpleAction": { + "description": "Action that is implemented and performed in (your) third-party application. Represents various functionality that is expected to be available to business and will help them with resolving the issue. The application should point the business to the place, where they can access the corresponding functionality. If the functionality is not supported, it is recommended to explain the situation to the business and provide them with instructions how to solve the issue.", + "id": "BuiltInSimpleAction", + "properties": { + "additionalContent": { + "$ref": "AdditionalContent", + "description": "Long text from an external source that should be available to the business. Present when the type is `SHOW_ADDITIONAL_CONTENT`." + }, + "attributeCode": { + "description": "The attribute that needs to be updated. Present when the type is `EDIT_ITEM_ATTRIBUTE`. This field contains a code for attribute, represented in snake_case. You can find a list of product's attributes, with their codes [here](https://support.google.com/merchants/answer/7052112).", + "type": "string" + }, + "type": { + "description": "The type of action that represents a functionality that is expected to be available in third-party application.", + "enum": [ + "BUILT_IN_SIMPLE_ACTION_TYPE_UNSPECIFIED", + "VERIFY_PHONE", + "CLAIM_WEBSITE", + "ADD_PRODUCTS", + "ADD_CONTACT_INFO", + "LINK_ADS_ACCOUNT", + "ADD_BUSINESS_REGISTRATION_NUMBER", + "EDIT_ITEM_ATTRIBUTE", + "FIX_ACCOUNT_ISSUE", + "SHOW_ADDITIONAL_CONTENT" + ], + "enumDescriptions": [ + "Default value. Will never be provided by the API.", + "Redirect the business to the part of your application where they can verify their phone.", + "Redirect the business to the part of your application where they can claim their website.", + "Redirect the business to the part of your application where they can add products.", + "Open a form where the business can edit their contact information.", + "Redirect the business to the part of your application where they can link ads account.", + "Open a form where the business can add their business registration number.", + "Open a form where the business can edit an attribute. The attribute that needs to be updated is specified in attribute_code field of the action.", + "Redirect the business from the product issues to the diagnostic page with their account issues in your application. This action will be returned only for product issues that are caused by an account issue and thus the business should resolve the problem on the account level.", + "Show additional content to the business. This action will be used for example to deliver a justification from national authority." + ], + "type": "string" + } + }, + "type": "object" + }, + "BuiltInUserInputAction": { + "description": "Action that is implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the business. They can start the action only when they provided all required inputs. The application will request processing of the action by calling the [triggeraction method](https://developers.google.com/merchant/api/reference/rest/issueresolution_v1beta/issueresolution/triggeraction).", + "id": "BuiltInUserInputAction", + "properties": { + "actionContext": { + "description": "Contains the action's context that must be included as part of the TriggerActionPayload.action_context in TriggerActionRequest.payload to call the `triggeraction` method. The content should be treated as opaque and must not be modified.", + "type": "string" + }, + "flows": { + "description": "Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.", + "items": { + "$ref": "ActionFlow" + }, + "type": "array" + } + }, + "type": "object" + }, + "Callout": { + "description": "An important message that should be highlighted. Usually displayed as a banner.", + "id": "Callout", + "properties": { + "fullMessage": { + "$ref": "TextWithTooltip", + "description": "A full message that needs to be shown to the business." + }, + "styleHint": { + "description": "Can be used to render messages with different severity in different styles. Snippets off all types contain important information that should be displayed to the business.", + "enum": [ + "CALLOUT_STYLE_HINT_UNSPECIFIED", + "ERROR", + "WARNING", + "INFO" + ], + "enumDescriptions": [ + "Default value. Will never be provided by the API.", + "The most important type of information highlighting problems, like an unsuccessful outcome of previously requested actions.", + "Information warning about pending problems, risks or deadlines.", + "Default severity for important information like pending status of previously requested action or cooldown for re-review." + ], + "type": "string" + } + }, + "type": "object" + }, + "CheckboxInput": { + "description": "Checkbox input allows the business to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). If the business checks the box, the input value for the field is `true`, otherwise it is `false`. This type of input is often used as a confirmation that the business completed required steps before they are allowed to start the action. In such a case, the input field is marked as required and the button to trigger the action should stay disabled until the business checks the box.", + "id": "CheckboxInput", + "properties": {}, + "type": "object" + }, + "CheckboxInputValue": { + "description": "Value for checkbox input field.", + "id": "CheckboxInputValue", + "properties": { + "value": { + "description": "Required. True if the business checked the box field. False otherwise.", + "type": "boolean" + } + }, + "type": "object" + }, + "ChoiceInput": { + "description": "Choice input allows the business to select one of the offered choices. Some choices may be linked to additional input fields that should be displayed under or next to the choice option. The value for the additional input field needs to be provided only when the specific choice is selected by the the business. For example, additional input field can be hidden or disabled until the business selects the specific choice.", + "id": "ChoiceInput", + "properties": { + "options": { + "description": "A list of choices. Only one option can be selected.", + "items": { + "$ref": "ChoiceInputOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "ChoiceInputOption": { + "description": "A choice that the business can select.", + "id": "ChoiceInputOption", + "properties": { + "additionalInput": { + "$ref": "InputField", + "description": "Input that should be displayed when this option is selected. The additional input will not contain a `ChoiceInput`." + }, + "id": { + "description": "Not for display but need to be sent back for the selected choice option.", + "type": "string" + }, + "label": { + "$ref": "TextWithTooltip", + "description": "Short description of the choice option. There may be more information to be shown as a tooltip." + } + }, + "type": "object" + }, + "ChoiceInputValue": { + "description": "Value for choice input field.", + "id": "ChoiceInputValue", + "properties": { + "choiceInputOptionId": { + "description": "Required. Id of the option that was selected by the business.", + "type": "string" + } + }, + "type": "object" + }, + "ExternalAction": { + "description": "Action that is implemented and performed outside of the third-party application. It should redirect the business to the provided URL of an external system where they can perform the action. For example to request a review in the Merchant Center.", + "id": "ExternalAction", + "properties": { + "type": { + "description": "The type of external action.", + "enum": [ + "EXTERNAL_ACTION_TYPE_UNSPECIFIED", + "REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER", + "REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER", + "LEGAL_APPEAL_IN_HELP_CENTER", + "VERIFY_IDENTITY_IN_MERCHANT_CENTER" + ], + "enumDescriptions": [ + "Default value. Will never be provided by the API.", + "Redirect to Merchant Center where the business can request a review for issue related to their product.", + "Redirect to Merchant Center where the business can request a review for issue related to their account.", + "Redirect to the form in Help Center where the business can request a legal appeal for the issue.", + "Redirect to Merchant Center where the business can perform identity verification." + ], + "type": "string" + }, + "uri": { + "description": "URL to external system, for example Merchant Center, where the business can perform the action.", + "type": "string" + } + }, + "type": "object" + }, + "Impact": { + "description": "Overall impact of the issue.", + "id": "Impact", + "properties": { + "breakdowns": { + "description": "Detailed impact breakdown. Explains the types of restriction the issue has in different shopping destinations and territory. If present, it should be rendered to the business. Can be shown as a mouse over dropdown or a dialog. Each breakdown item represents a group of regions with the same impact details.", + "items": { + "$ref": "Breakdown" + }, + "type": "array" + }, + "message": { + "description": "Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the business. For example: \"Disapproves 90k offers in 25 countries\"", + "type": "string" + }, + "severity": { + "description": "The severity of the issue.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "ERROR", + "WARNING", + "INFO" + ], + "enumDescriptions": [ + "Default value. Will never be provided by the API.", + "Causes either an account suspension or an item disapproval. Errors should be resolved as soon as possible to ensure items are eligible to appear in results again.", + "Warnings can negatively impact the performance of ads and can lead to item or account suspensions in the future unless the issue is resolved.", + "Infos are suggested optimizations to increase data quality. Resolving these issues is recommended, but not required." + ], + "type": "string" + } + }, + "type": "object" + }, + "InputField": { + "description": "Input field that needs to be available to the business. If the field is marked as required, then a value needs to be provided for a successful processing of the request.", + "id": "InputField", + "properties": { + "checkboxInput": { + "$ref": "CheckboxInput", + "description": "Input field to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox)." + }, + "choiceInput": { + "$ref": "ChoiceInput", + "description": "Input field to select one of the offered choices. Corresponds to the [html input type=radio](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.radio.html#input.radio)." + }, + "id": { + "description": "Not for display but need to be sent back for the given input field.", + "type": "string" + }, + "label": { + "$ref": "TextWithTooltip", + "description": "Input field label. There may be more information to be shown in a tooltip." + }, + "required": { + "description": "Whether the field is required. The action button needs to stay disabled till values for all required fields are provided.", + "type": "boolean" + }, + "textInput": { + "$ref": "TextInput", + "description": "Input field to provide text information. Corresponds to the [html input type=text](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text) or [html textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea)." + } + }, + "type": "object" + }, + "InputValue": { + "description": "Input provided by the business for input field.", + "id": "InputValue", + "properties": { + "checkboxInputValue": { + "$ref": "CheckboxInputValue", + "description": "Value for checkbox input field." + }, + "choiceInputValue": { + "$ref": "ChoiceInputValue", + "description": "Value for choice input field." + }, + "inputFieldId": { + "description": "Required. Id of the corresponding input field.", + "type": "string" + }, + "textInputValue": { + "$ref": "TextInputValue", + "description": "Value for text input field." + } + }, + "type": "object" + }, + "ProductChange": { + "description": "The change that happened to the product including old value, new value, country code as the region code and reporting context.", + "id": "ProductChange", + "properties": { + "newValue": { + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", + "type": "string" + }, + "oldValue": { + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", + "type": "string" + }, + "regionCode": { + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", + "type": "string" + }, + "reportingContext": { + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", + "enum": [ + "REPORTING_CONTEXT_ENUM_UNSPECIFIED", + "SHOPPING_ADS", + "DISCOVERY_ADS", + "DEMAND_GEN_ADS", + "DEMAND_GEN_ADS_DISCOVER_SURFACE", + "VIDEO_ADS", + "DISPLAY_ADS", + "LOCAL_INVENTORY_ADS", + "VEHICLE_INVENTORY_ADS", + "FREE_LISTINGS", + "FREE_LOCAL_LISTINGS", + "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", + "YOUTUBE_SHOPPING", + "CLOUD_RETAIL", + "LOCAL_CLOUD_RETAIL", + "PRODUCT_REVIEWS", + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" + ], + "enumDeprecated": [ + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Not specified.", + "[Shopping ads](https://support.google.com/merchants/answer/6149970).", + "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", + "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", + "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", + "[Video ads](https://support.google.com/google-ads/answer/6340491).", + "[Display ads](https://support.google.com/merchants/answer/6069387).", + "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", + "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", + "[Free product listings](https://support.google.com/merchants/answer/9199328).", + "[Free local product listings](https://support.google.com/merchants/answer/9825611).", + "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", + "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", + "[Cloud retail](https://cloud.google.com/solutions/retail).", + "[Local cloud retail](https://cloud.google.com/solutions/retail).", + "[Product Reviews](https://support.google.com/merchants/answer/14620732).", + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "YouTube Checkout ." + ], + "type": "string" + } + }, + "type": "object" + }, + "ProductStatusChangeMessage": { + "description": "The message that the merchant will receive to notify about product status change event", + "id": "ProductStatusChangeMessage", + "properties": { + "account": { + "description": "The target account that owns the entity that changed. Format : `accounts/{merchant_id}`", + "type": "string" + }, + "attribute": { + "description": "The attribute in the resource that changed, in this case it will be always `Status`.", + "enum": [ + "ATTRIBUTE_UNSPECIFIED", + "STATUS" + ], + "enumDescriptions": [ + "Unspecified attribute", + "Status of the changed entity" + ], + "type": "string" + }, + "changes": { + "description": "A message to describe the change that happened to the product", + "items": { + "$ref": "ProductChange" + }, + "type": "array" + }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, + "expirationTime": { + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "format": "google-datetime", + "type": "string" + }, + "managingAccount": { + "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", + "type": "string" + }, + "resource": { + "description": "The product name. Format: `accounts/{account}/products/{product}`", + "type": "string" + }, + "resourceId": { + "description": "The product id.", + "type": "string" + }, + "resourceType": { + "description": "The resource that changed, in this case it will always be `Product`.", + "enum": [ + "RESOURCE_UNSPECIFIED", + "PRODUCT" + ], + "enumDescriptions": [ + "Unspecified resource", + "Resource type : product" + ], + "type": "string" + } + }, + "type": "object" + }, + "Reason": { + "description": "A single reason why the action is not available.", + "id": "Reason", + "properties": { + "action": { + "$ref": "Action", + "description": "Optional. An action that needs to be performed to solve the problem represented by this reason. This action will always be available. Should be rendered as a link or button next to the summarizing message. For example, the review may be available only once the business configure all required attributes. In such a situation this action can be a link to the form, where they can fill the missing attribute to unblock the main action." + }, + "detail": { + "description": "Detailed explanation of the reason. Should be displayed as a hint if present.", + "type": "string" + }, + "message": { + "description": "Messages summarizing the reason, why the action is not available. For example: \"Review requested on Jan 03. Review requests can take a few days to complete.\"", + "type": "string" + } + }, + "type": "object" + }, + "Region": { + "description": "Region with code and localized name.", + "id": "Region", + "properties": { + "code": { + "description": "The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)", + "type": "string" + }, + "name": { + "description": "The localized name of the region. For region with code='001' the value is 'All countries' or the equivalent in other languages.", + "type": "string" + } + }, + "type": "object" + }, + "RenderAccountIssuesResponse": { + "description": "Response containing an issue resolution content and actions for listed account issues.", + "id": "RenderAccountIssuesResponse", + "properties": { + "renderedIssues": { + "description": "List of account issues for a given account. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered.", + "items": { + "$ref": "RenderedIssue" + }, + "type": "array" + } + }, + "type": "object" + }, + "RenderIssuesRequestPayload": { + "description": "The payload for configuring how the content should be rendered.", + "id": "RenderIssuesRequestPayload", + "properties": { + "contentOption": { + "description": "Optional. How the detailed content should be returned. Default option is to return the content as a pre-rendered HTML text.", + "enum": [ + "CONTENT_OPTION_UNSPECIFIED", + "PRE_RENDERED_HTML" + ], + "enumDescriptions": [ + "Default value. Will never be provided by the API.", + "Returns the detail of the issue as a pre-rendered HTML text." + ], + "type": "string" + }, + "userInputActionOption": { + "description": "Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points the business to Merchant Center where they can request the action.", + "enum": [ + "USER_INPUT_ACTION_RENDERING_OPTION_UNSPECIFIED", + "REDIRECT_TO_MERCHANT_CENTER", + "BUILT_IN_USER_INPUT_ACTIONS" + ], + "enumDescriptions": [ + "Default value. Will never be provided by the API.", + "Actions that require user input are represented only as links that points the business to Merchant Center where they can request the action. Provides easier to implement alternative to `BUILT_IN_USER_INPUT_ACTIONS`.", + "Returns content and input form definition for each complex action. Your application needs to display this content and input form to the business before they can request processing of the action. To start the action, your application needs to call the `triggeraction` method." + ], + "type": "string" + } + }, + "type": "object" + }, + "RenderProductIssuesResponse": { + "description": "Response containing an issue resolution content and actions for listed product issues.", + "id": "RenderProductIssuesResponse", + "properties": { + "renderedIssues": { + "description": "List of issues for a given product. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered.", + "items": { + "$ref": "RenderedIssue" + }, + "type": "array" + } + }, + "type": "object" + }, + "RenderedIssue": { + "description": "An issue affecting specific business or their product.", + "id": "RenderedIssue", + "properties": { + "actions": { + "description": "A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue. Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.", + "items": { + "$ref": "Action" + }, + "type": "array" + }, + "impact": { + "$ref": "Impact", + "description": "Clarifies the severity of the issue. The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue. The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement. Issues with different severity can be styled differently. They may use a different color or icon to signal the difference between `ERROR`, `WARNING` and `INFO`." + }, + "prerenderedContent": { + "description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.", + "type": "string" + }, + "prerenderedOutOfCourtDisputeSettlement": { + "description": "Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.", + "type": "string" + }, + "title": { + "description": "Title of the issue.", + "type": "string" + } + }, + "type": "object" + }, + "TextInput": { + "description": "Text input allows the business to provide a text value.", + "id": "TextInput", + "properties": { + "additionalInfo": { + "$ref": "TextWithTooltip", + "description": "Additional info regarding the field to be displayed to the business. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip." + }, + "ariaLabel": { + "description": "Text to be used as the [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the input.", + "type": "string" + }, + "formatInfo": { + "description": "Information about the required format. If present, it should be shown close to the input field to help the business to provide a correct value. For example: \"VAT numbers should be in a format similar to SK9999999999\"", + "type": "string" + }, + "type": { + "description": "Type of the text input", + "enum": [ + "TEXT_INPUT_TYPE_UNSPECIFIED", + "GENERIC_SHORT_TEXT", + "GENERIC_LONG_TEXT" + ], + "enumDescriptions": [ + "Default value. Will never be provided by the API.", + "Used when a short text is expected. The field can be rendered as a [text field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).", + "Used when a longer text is expected. The field should be rendered as a [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea)." + ], + "type": "string" + } + }, + "type": "object" + }, + "TextInputValue": { + "description": "Value for text input field.", + "id": "TextInputValue", + "properties": { + "value": { + "description": "Required. Text provided by the business.", + "type": "string" + } + }, + "type": "object" + }, + "TextWithTooltip": { + "description": "Block of text that may contain a tooltip with more information.", + "id": "TextWithTooltip", + "properties": { + "simpleTooltipValue": { + "description": "Value of the tooltip as a simple text.", + "type": "string" + }, + "simpleValue": { + "description": "Value of the message as a simple text.", + "type": "string" + }, + "tooltipIconStyle": { + "description": "The suggested type of an icon for tooltip, if a tooltip is present.", + "enum": [ + "TOOLTIP_ICON_STYLE_UNSPECIFIED", + "INFO", + "QUESTION" + ], + "enumDescriptions": [ + "Default value. Will never be provided by the API.", + "Used when the tooltip adds additional information to the context, the 'i' can be used as an icon.", + "Used when the tooltip shows helpful information, the '?' can be used as an icon." + ], + "type": "string" + } + }, + "type": "object" + }, + "TriggerActionPayload": { + "description": "The payload for the triggered action.", + "id": "TriggerActionPayload", + "properties": { + "actionContext": { + "description": "Required. The context from the selected action. The value is obtained from rendered issues and needs to be sent back to identify the action that is being triggered.", + "type": "string" + }, + "actionInput": { + "$ref": "ActionInput", + "description": "Required. Input provided by the business." + } + }, + "type": "object" + }, + "TriggerActionResponse": { + "description": "Response informing about the started action.", + "id": "TriggerActionResponse", + "properties": { + "message": { + "description": "The message for the business.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Merchant API", + "version": "issueresolution_v1beta", + "version_module": true +} \ No newline at end of file diff --git a/discovery/merchantapi-ordertracking_v1beta.json b/discovery/merchantapi-ordertracking_v1beta.json new file mode 100644 index 0000000000..f203fa3e0b --- /dev/null +++ b/discovery/merchantapi-ordertracking_v1beta.json @@ -0,0 +1,566 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/content": { + "description": "Manage your product listings and accounts for Google Shopping" + } + } + } + }, + "basePath": "", + "baseUrl": "https://merchantapi.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Merchant", + "description": "Programmatically manage your Merchant Center Accounts.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "merchantapi:ordertracking_v1beta", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://merchantapi.mtls.googleapis.com/", + "name": "merchantapi", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "accounts": { + "resources": { + "ordertrackingsignals": { + "methods": { + "create": { + "description": "Creates new order tracking signal.", + "flatPath": "ordertracking/v1beta/accounts/{accountsId}/ordertrackingsignals", + "httpMethod": "POST", + "id": "merchantapi.accounts.ordertrackingsignals.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "orderTrackingSignalId": { + "description": "Output only. The ID that uniquely identifies this order tracking signal.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account of the business for which the order signal is created. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "ordertracking/v1beta/{+parent}/ordertrackingsignals", + "request": { + "$ref": "OrderTrackingSignal" + }, + "response": { + "$ref": "OrderTrackingSignal" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + } + } + } + }, + "revision": "20250505", + "rootUrl": "https://merchantapi.googleapis.com/", + "schemas": { + "DateTime": { + "description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.", + "id": "DateTime", + "properties": { + "day": { + "description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.", + "format": "int32", + "type": "integer" + }, + "hours": { + "description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Time zone." + }, + "utcOffset": { + "description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.", + "format": "google-duration", + "type": "string" + }, + "year": { + "description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LineItemDetails": { + "description": "The line items of the order.", + "id": "LineItemDetails", + "properties": { + "brand": { + "description": "Optional. Brand of the product.", + "type": "string" + }, + "gtin": { + "description": "Optional. The Global Trade Item Number.", + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID for this line item.", + "type": "string" + }, + "mpn": { + "description": "Optional. The manufacturer part number.", + "type": "string" + }, + "productId": { + "description": "Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId.", + "type": "string" + }, + "productTitle": { + "description": "Optional. Plain text title of this product.", + "type": "string" + }, + "quantity": { + "description": "Required. The quantity of the line item in the order.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "OrderTrackingSignal": { + "description": "Represents a business trade from which signals are extracted, such as shipping.", + "id": "OrderTrackingSignal", + "properties": { + "customerShippingFee": { + "$ref": "Price", + "description": "Optional. The shipping fee of the order; this value should be set to zero in the case of free shipping." + }, + "deliveryPostalCode": { + "description": "Optional. The delivery postal code, as a continuous string without spaces or dashes, for example \"95016\". This field will be anonymized in returned OrderTrackingSignal creation response.", + "type": "string" + }, + "deliveryRegionCode": { + "description": "Optional. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination.", + "type": "string" + }, + "lineItems": { + "description": "Required. Information about line items in the order.", + "items": { + "$ref": "LineItemDetails" + }, + "type": "array" + }, + "merchantId": { + "description": "Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals).", + "format": "int64", + "type": "string" + }, + "orderCreatedTime": { + "$ref": "DateTime", + "description": "Required. The time when the order was created on the businesses side. Include the year and timezone string, if available." + }, + "orderId": { + "description": "Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response.", + "type": "string" + }, + "orderTrackingSignalId": { + "description": "Output only. The ID that uniquely identifies this order tracking signal.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "shipmentLineItemMapping": { + "description": "Optional. The mapping of the line items to the shipment information.", + "items": { + "$ref": "ShipmentLineItemMapping" + }, + "type": "array" + }, + "shippingInfo": { + "description": "Required. The shipping information for the order.", + "items": { + "$ref": "ShippingInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "Price": { + "description": "The price represented as a number and currency.", + "id": "Price", + "properties": { + "amountMicros": { + "description": "The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).", + "format": "int64", + "type": "string" + }, + "currencyCode": { + "description": "The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).", + "type": "string" + } + }, + "type": "object" + }, + "ProductChange": { + "description": "The change that happened to the product including old value, new value, country code as the region code and reporting context.", + "id": "ProductChange", + "properties": { + "newValue": { + "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", + "type": "string" + }, + "oldValue": { + "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", + "type": "string" + }, + "regionCode": { + "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", + "type": "string" + }, + "reportingContext": { + "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", + "enum": [ + "REPORTING_CONTEXT_ENUM_UNSPECIFIED", + "SHOPPING_ADS", + "DISCOVERY_ADS", + "DEMAND_GEN_ADS", + "DEMAND_GEN_ADS_DISCOVER_SURFACE", + "VIDEO_ADS", + "DISPLAY_ADS", + "LOCAL_INVENTORY_ADS", + "VEHICLE_INVENTORY_ADS", + "FREE_LISTINGS", + "FREE_LOCAL_LISTINGS", + "FREE_LOCAL_VEHICLE_LISTINGS", + "YOUTUBE_AFFILIATE", + "YOUTUBE_SHOPPING", + "CLOUD_RETAIL", + "LOCAL_CLOUD_RETAIL", + "PRODUCT_REVIEWS", + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" + ], + "enumDeprecated": [ + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Not specified.", + "[Shopping ads](https://support.google.com/merchants/answer/6149970).", + "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", + "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", + "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", + "[Video ads](https://support.google.com/google-ads/answer/6340491).", + "[Display ads](https://support.google.com/merchants/answer/6069387).", + "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", + "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", + "[Free product listings](https://support.google.com/merchants/answer/9199328).", + "[Free local product listings](https://support.google.com/merchants/answer/9825611).", + "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", + "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", + "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", + "[Cloud retail](https://cloud.google.com/solutions/retail).", + "[Local cloud retail](https://cloud.google.com/solutions/retail).", + "[Product Reviews](https://support.google.com/merchants/answer/14620732).", + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "YouTube Checkout ." + ], + "type": "string" + } + }, + "type": "object" + }, + "ProductStatusChangeMessage": { + "description": "The message that the merchant will receive to notify about product status change event", + "id": "ProductStatusChangeMessage", + "properties": { + "account": { + "description": "The target account that owns the entity that changed. Format : `accounts/{merchant_id}`", + "type": "string" + }, + "attribute": { + "description": "The attribute in the resource that changed, in this case it will be always `Status`.", + "enum": [ + "ATTRIBUTE_UNSPECIFIED", + "STATUS" + ], + "enumDescriptions": [ + "Unspecified attribute", + "Status of the changed entity" + ], + "type": "string" + }, + "changes": { + "description": "A message to describe the change that happened to the product", + "items": { + "$ref": "ProductChange" + }, + "type": "array" + }, + "eventTime": { + "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", + "format": "google-datetime", + "type": "string" + }, + "expirationTime": { + "description": "Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.", + "format": "google-datetime", + "type": "string" + }, + "managingAccount": { + "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", + "type": "string" + }, + "resource": { + "description": "The product name. Format: `accounts/{account}/products/{product}`", + "type": "string" + }, + "resourceId": { + "description": "The product id.", + "type": "string" + }, + "resourceType": { + "description": "The resource that changed, in this case it will always be `Product`.", + "enum": [ + "RESOURCE_UNSPECIFIED", + "PRODUCT" + ], + "enumDescriptions": [ + "Unspecified resource", + "Resource type : product" + ], + "type": "string" + } + }, + "type": "object" + }, + "ShipmentLineItemMapping": { + "description": "Represents how many items are in the shipment for the given shipment_id and line_item_id.", + "id": "ShipmentLineItemMapping", + "properties": { + "lineItemId": { + "description": "Required. The line item ID.", + "type": "string" + }, + "quantity": { + "description": "Required. The line item quantity in the shipment.", + "format": "int64", + "type": "string" + }, + "shipmentId": { + "description": "Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.", + "type": "string" + } + }, + "type": "object" + }, + "ShippingInfo": { + "description": "The shipping information for the order.", + "id": "ShippingInfo", + "properties": { + "actualDeliveryTime": { + "$ref": "DateTime", + "description": "Optional. The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name." + }, + "carrier": { + "description": "Optional. The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.", + "type": "string" + }, + "carrierService": { + "description": "Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc.", + "type": "string" + }, + "earliestDeliveryPromiseTime": { + "$ref": "DateTime", + "description": "Optional. The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name." + }, + "latestDeliveryPromiseTime": { + "$ref": "DateTime", + "description": "Optional. The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name." + }, + "originPostalCode": { + "description": "Required. The origin postal code, as a continuous string without spaces or dashes, for example \"95016\". This field will be anonymized in returned OrderTrackingSignal creation response.", + "type": "string" + }, + "originRegionCode": { + "description": "Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.", + "type": "string" + }, + "shipmentId": { + "description": "Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.", + "type": "string" + }, + "shippedTime": { + "$ref": "DateTime", + "description": "Optional. The time when the shipment was shipped. Include the year and timezone string, if available." + }, + "shippingStatus": { + "description": "Required. The status of the shipment.", + "enum": [ + "SHIPPING_STATE_UNSPECIFIED", + "SHIPPED", + "DELIVERED" + ], + "enumDescriptions": [ + "The shipping status is not known to business.", + "All items are shipped.", + "The shipment is already delivered." + ], + "type": "string" + }, + "trackingId": { + "description": "Optional. The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.", + "type": "string" + } + }, + "type": "object" + }, + "TimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "TimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Merchant API", + "version": "ordertracking_v1beta", + "version_module": true +} \ No newline at end of file diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index 9cdec418aa..def8cbe8a1 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-v1.json @@ -1690,7 +1690,7 @@ } } }, - "revision": "20250324", + "revision": "20250514", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2696,6 +2696,13 @@ }, "type": "object" }, + "MessageSet": { + "deprecated": true, + "description": "This is proto2's version of MessageSet.DEPRECATED: DO NOT USE FOR NEW FIELDS.If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use Any instead.MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2.This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, "MetadataExport": { "description": "The details of a metadata export operation.", "id": "MetadataExport", @@ -3522,6 +3529,35 @@ }, "type": "object" }, + "StatusProto": { + "description": "Wire-format for a Status object", + "id": "StatusProto", + "properties": { + "canonicalCode": { + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;", + "type": "string" + }, + "messageSet": { + "$ref": "MessageSet", + "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" + }, + "space": { + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", + "type": "string" + } + }, + "type": "object" + }, "TelemetryConfig": { "description": "Telemetry Configuration for the Dataproc Metastore service.", "id": "TelemetryConfig", diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index 8f4cc5a61f..0ab49598bf 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.json @@ -1802,7 +1802,7 @@ } } }, - "revision": "20250410", + "revision": "20250514", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2885,6 +2885,13 @@ }, "type": "object" }, + "MessageSet": { + "deprecated": true, + "description": "This is proto2's version of MessageSet.DEPRECATED: DO NOT USE FOR NEW FIELDS.If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use Any instead.MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2.This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, "MetadataExport": { "description": "The details of a metadata export operation.", "id": "MetadataExport", @@ -3783,6 +3790,35 @@ }, "type": "object" }, + "StatusProto": { + "description": "Wire-format for a Status object", + "id": "StatusProto", + "properties": { + "canonicalCode": { + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;", + "type": "string" + }, + "messageSet": { + "$ref": "MessageSet", + "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" + }, + "space": { + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", + "type": "string" + } + }, + "type": "object" + }, "TelemetryConfig": { "description": "Telemetry Configuration for the Dataproc Metastore service.", "id": "TelemetryConfig", diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index 2f0eb4ff62..8ed833bb4e 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.json @@ -1802,7 +1802,7 @@ } } }, - "revision": "20250410", + "revision": "20250514", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2885,6 +2885,13 @@ }, "type": "object" }, + "MessageSet": { + "deprecated": true, + "description": "This is proto2's version of MessageSet.DEPRECATED: DO NOT USE FOR NEW FIELDS.If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use Any instead.MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2.This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, "MetadataExport": { "description": "The details of a metadata export operation.", "id": "MetadataExport", @@ -3783,6 +3790,35 @@ }, "type": "object" }, + "StatusProto": { + "description": "Wire-format for a Status object", + "id": "StatusProto", + "properties": { + "canonicalCode": { + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;", + "type": "string" + }, + "messageSet": { + "$ref": "MessageSet", + "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" + }, + "space": { + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", + "type": "string" + } + }, + "type": "object" + }, "TelemetryConfig": { "description": "Telemetry Configuration for the Dataproc Metastore service.", "id": "TelemetryConfig", diff --git a/discovery/migrationcenter-v1.json b/discovery/migrationcenter-v1.json index a39040f2ee..b601e1af3b 100644 --- a/discovery/migrationcenter-v1.json +++ b/discovery/migrationcenter-v1.json @@ -2407,7 +2407,7 @@ } } }, - "revision": "20250422", + "revision": "20250429", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2890,6 +2890,13 @@ "description": "Optional. When this value is set to `true` the request is a no-op for non-existing assets. See https://google.aip.dev/135#delete-if-existing for additional details. Default value is `false`.", "type": "boolean" }, + "cascadingRules": { + "description": "Optional. Optional cascading rules for deleting related assets.", + "items": { + "$ref": "CascadingRule" + }, + "type": "array" + }, "names": { "description": "Required. The IDs of the assets to delete. A maximum of 1000 assets can be deleted in a batch. Format: projects/{project}/locations/{location}/assets/{name}.", "items": { @@ -2966,6 +2973,23 @@ "properties": {}, "type": "object" }, + "CascadeLogicalDBsRule": { + "description": "Cascading rule for related logical DBs.", + "id": "CascadeLogicalDBsRule", + "properties": {}, + "type": "object" + }, + "CascadingRule": { + "description": "Specifies cascading rules for traversing relations.", + "id": "CascadingRule", + "properties": { + "cascadeLogicalDbs": { + "$ref": "CascadeLogicalDBsRule", + "description": "Cascading rule for related logical DBs." + } + }, + "type": "object" + }, "ComputeEngineMigrationTarget": { "description": "Compute engine migration target.", "id": "ComputeEngineMigrationTarget", diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index 45a2e098bd..a03e072e78 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -2554,7 +2554,7 @@ } } }, - "revision": "20250422", + "revision": "20250515", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -4647,7 +4647,7 @@ "vmwareConfig": { "$ref": "VmwareDiskConfig", "deprecated": true, - "description": "VMware disk details." + "description": "VMware disk details. Deprecated" } }, "type": "object" diff --git a/discovery/monitoring-v1.json b/discovery/monitoring-v1.json index 17ed33179e..caae5574f7 100644 --- a/discovery/monitoring-v1.json +++ b/discovery/monitoring-v1.json @@ -753,7 +753,7 @@ } } }, - "revision": "20250424", + "revision": "20250501", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -2928,7 +2928,7 @@ "properties": { "templateVariableCondition": { "$ref": "TemplateVariableCondition", - "description": "A condition whose evaluation is based on the value of a template1 variable." + "description": "A condition whose evaluation is based on the value of a template variable." } }, "type": "object" diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index eb0d97fb2a..60bb1e4624 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -2720,7 +2720,7 @@ } } }, - "revision": "20250323", + "revision": "20250508", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -3415,7 +3415,7 @@ "id": "Criteria", "properties": { "filter": { - "description": "Optional. The filter string to match on Alert fields when silencing the alerts. It follows the standard https://google.aip.dev/160 syntax. A filter string used to apply the snooze to specific incidents that have matching filter values. Filters can be defined for snoozes that apply to one alerting policy. Filters must be a string formatted as one or more resource labels with specific label values. If multiple resource labels are used, then they must be connected with an AND operator. For example, the following filter applies the snooze to incidents that have an instance ID of 1234567890 and a zone of us-central1-a: resource.labels.instance_id=\"1234567890\" AND resource.labels.zone=\"us-central1-a\" ", + "description": "Optional. When you define a snooze, you can also define a filter for that snooze. The filter is a string containing one or more key-value pairs. The string uses the standard https://google.aip.dev/160 filter syntax. If you define a filter for a snooze, then the snooze can only apply to one alert policy. When the snooze is active, incidents won't be created when the incident would have key-value pairs (labels) that match those specified by the filter in the snooze.Snooze filters support resource, metric, and metadata labels. If multiple labels are used, then they must be connected with an AND operator. For example, the following filter applies the snooze to incidents that have a resource label with an instance ID of \"1234567890\", a metric label with an instance name of \"group\", a metadata user label with a key of \"foo\" and a value of \"bar\", and a metadata system label with a key of \"region\" and a value of \"us-central1\": \"filter\": \"resource.labels.instance_id=\\\"1234567890\\\" AND metric.labels.instance_name=\\\"test_group\\\" AND metadata.user_labels.foo=\\\"bar\\\" AND metadata.system_labels.region=\\\"us-central1\\\"\" ", "type": "string" }, "policies": { diff --git a/discovery/netapp-v1.json b/discovery/netapp-v1.json index 3b099e2bf4..73b901b6c6 100644 --- a/discovery/netapp-v1.json +++ b/discovery/netapp-v1.json @@ -2270,7 +2270,7 @@ } } }, - "revision": "20250326", + "revision": "20250515", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -2444,6 +2444,12 @@ "description": "A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.", "type": "string" }, + "enforcedRetentionEndTime": { + "description": "Output only. The time until which the backup is not deletable.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -2612,6 +2618,34 @@ }, "type": "object" }, + "BackupRetentionPolicy": { + "description": "Retention policy for backups in the backup vault", + "id": "BackupRetentionPolicy", + "properties": { + "backupMinimumEnforcedRetentionDays": { + "description": "Required. Minimum retention duration in days for backups in the backup vault.", + "format": "int32", + "type": "integer" + }, + "dailyBackupImmutable": { + "description": "Optional. Indicates if the daily backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", + "type": "boolean" + }, + "manualBackupImmutable": { + "description": "Optional. Indicates if the manual backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", + "type": "boolean" + }, + "monthlyBackupImmutable": { + "description": "Optional. Indicates if the monthly backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", + "type": "boolean" + }, + "weeklyBackupImmutable": { + "description": "Optional. Indicates if the weekly backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", + "type": "boolean" + } + }, + "type": "object" + }, "BackupVault": { "description": "A NetApp BackupVault.", "id": "BackupVault", @@ -2620,6 +2654,10 @@ "description": "Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`", "type": "string" }, + "backupRetentionPolicy": { + "$ref": "BackupRetentionPolicy", + "description": "Optional. Backup retention policy defining the retenton of backups." + }, "backupVaultType": { "description": "Optional. Type of backup vault to be created. Default is IN_REGION.", "enum": [ @@ -3983,6 +4021,10 @@ "readOnly": true, "type": "string" }, + "customPerformanceEnabled": { + "description": "Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false", + "type": "boolean" + }, "description": { "description": "Optional. Description of the storage pool", "type": "string" @@ -4096,6 +4138,16 @@ "readOnly": true, "type": "string" }, + "totalIops": { + "description": "Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the total_throughput_mibps", + "format": "int64", + "type": "string" + }, + "totalThroughputMibps": { + "description": "Optional. Custom Performance Total Throughput of the pool (in MiB/s)", + "format": "int64", + "type": "string" + }, "volumeCapacityGib": { "description": "Output only. Allocated size of all volumes in GIB in the storage pool", "format": "int64", @@ -4187,7 +4239,7 @@ "type": "string" }, "transferBytes": { - "description": "Cumulative bytes trasferred so far for the replication relatinonship.", + "description": "Cumulative bytes transferred so far for the replication relationship.", "format": "int64", "type": "string" }, diff --git a/discovery/netapp-v1beta1.json b/discovery/netapp-v1beta1.json index 433bc50806..9f140021ad 100644 --- a/discovery/netapp-v1beta1.json +++ b/discovery/netapp-v1beta1.json @@ -2270,7 +2270,7 @@ } } }, - "revision": "20250326", + "revision": "20250515", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -2444,6 +2444,12 @@ "description": "A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.", "type": "string" }, + "enforcedRetentionEndTime": { + "description": "Output only. The time until which the backup is not deletable.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -2612,6 +2618,34 @@ }, "type": "object" }, + "BackupRetentionPolicy": { + "description": "Retention policy for backups in the backup vault", + "id": "BackupRetentionPolicy", + "properties": { + "backupMinimumEnforcedRetentionDays": { + "description": "Required. Minimum retention duration in days for backups in the backup vault.", + "format": "int32", + "type": "integer" + }, + "dailyBackupImmutable": { + "description": "Optional. Indicates if the daily backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", + "type": "boolean" + }, + "manualBackupImmutable": { + "description": "Optional. Indicates if the manual backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", + "type": "boolean" + }, + "monthlyBackupImmutable": { + "description": "Optional. Indicates if the monthly backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", + "type": "boolean" + }, + "weeklyBackupImmutable": { + "description": "Optional. Indicates if the weekly backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true.", + "type": "boolean" + } + }, + "type": "object" + }, "BackupVault": { "description": "A NetApp BackupVault.", "id": "BackupVault", @@ -2620,6 +2654,10 @@ "description": "Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`", "type": "string" }, + "backupRetentionPolicy": { + "$ref": "BackupRetentionPolicy", + "description": "Optional. Backup retention policy defining the retenton of backups." + }, "backupVaultType": { "description": "Optional. Type of backup vault to be created. Default is IN_REGION.", "enum": [ @@ -3991,6 +4029,10 @@ "description": "Optional. Description of the storage pool", "type": "string" }, + "enableHotTierAutoResize": { + "description": "Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size.", + "type": "boolean" + }, "encryptionType": { "description": "Output only. Specifies the current pool encryption key source.", "enum": [ @@ -4011,6 +4053,11 @@ "description": "Deprecated. Used to allow SO pool to access AD or DNS server from other regions.", "type": "boolean" }, + "hotTierSizeGib": { + "description": "Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set.", + "format": "int64", + "type": "string" + }, "kmsConfig": { "description": "Optional. Specifies the KMS config to be used for volume encryption.", "type": "string" @@ -4150,6 +4197,10 @@ "format": "int32", "type": "integer" }, + "hotTierBypassModeEnabled": { + "description": "Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level.", + "type": "boolean" + }, "tierAction": { "description": "Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED.", "enum": [ @@ -4201,7 +4252,7 @@ "type": "string" }, "transferBytes": { - "description": "Cumulative bytes trasferred so far for the replication relatinonship.", + "description": "Cumulative bytes transferred so far for the replication relationship.", "format": "int64", "type": "string" }, diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index 9508569250..4f459edadc 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-v1.json @@ -1366,6 +1366,37 @@ "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}/internalRanges/{internalRangesId}:getIamPolicy", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.internalRanges.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists internal ranges in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges", @@ -1450,6 +1481,62 @@ "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}/internalRanges/{internalRangesId}:setIamPolicy", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.internalRanges.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/internalRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/internalRanges/{internalRangesId}:testIamPermissions", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.internalRanges.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/[^/]+/internalRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -2925,7 +3012,7 @@ } } }, - "revision": "20250414", + "revision": "20250512", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -2973,6 +3060,36 @@ }, "type": "object" }, + "AllocationOptions": { + "description": "Range auto-allocation options, to be optionally used when CIDR block is not explicitly set.", + "id": "AllocationOptions", + "properties": { + "allocationStrategy": { + "description": "Optional. Allocation strategy Not setting this field when the allocation is requested means an implementation defined strategy is used.", + "enum": [ + "ALLOCATION_STRATEGY_UNSPECIFIED", + "RANDOM", + "FIRST_AVAILABLE", + "RANDOM_FIRST_N_AVAILABLE", + "FIRST_SMALLEST_FITTING" + ], + "enumDescriptions": [ + "Unspecified strategy must be used when the range is specified explicitly using ip_cidr_range field. Othherwise unspefified means using the default strategy.", + "Random strategy, the legacy algorithm, used for backwards compatibility. This allocation strategy remains efficient in the case of concurrent allocation requests in the same peered network space and doesn't require providing the level of concurrency in an explicit parameter, but it is prone to fragmenting available address space.", + "Pick the first available address range. This strategy is deterministic and the result is easy to predict.", + "Pick an arbitrary range out of the first N available ones. The N will be set in the first_available_ranges_lookup_size field. This strategy should be used when concurrent allocation requests are made in the same space of peered networks while the fragmentation of the addrress space is reduced.", + "Pick the smallest but fitting available range. This deterministic strategy minimizes fragmentation of the address space." + ], + "type": "string" + }, + "firstAvailableRangesLookupSize": { + "description": "Optional. This field must be set only when allocation_strategy is set to RANDOM_FIRST_N_AVAILABLE. The value should be the maximum expected parallelism of range creation requests issued to the same space of peered netwroks.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -3282,7 +3399,7 @@ "id": "Filter", "properties": { "destRange": { - "description": "Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4.", + "description": "Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4 and \"::/0\" if protocol version is IPv6.", "type": "string" }, "ipProtocol": { @@ -3290,19 +3407,21 @@ "type": "string" }, "protocolVersion": { - "description": "Required. Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported. IPV6 is supported in preview.", + "description": "Required. Internet protocol versions this policy-based route applies to. IPV4 and IPV6 is supported.", "enum": [ "PROTOCOL_VERSION_UNSPECIFIED", - "IPV4" + "IPV4", + "IPV6" ], "enumDescriptions": [ "Default value.", - "The PBR is for IPv4 internet protocol traffic." + "The PBR is for IPv4 internet protocol traffic.", + "The PBR is for IPv6 internet protocol traffic." ], "type": "string" }, "srcRange": { - "description": "Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4.", + "description": "Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4 and \"::/0\" if protocol version is IPv6.", "type": "string" } }, @@ -3646,6 +3765,10 @@ "description": "The internal range resource for IPAM operations within a VPC network. Used to represent a private address range along with behavioral characteristics of that range (its usage and peering behavior). Networking resources can link to this range if they are created as belonging to it.", "id": "InternalRange", "properties": { + "allocationOptions": { + "$ref": "AllocationOptions", + "description": "Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length)." + }, "createTime": { "description": "Time when the internal range was created.", "format": "google-datetime", @@ -4411,6 +4534,21 @@ }, "type": "object" }, + "NextHopSpoke": { + "description": "A route next hop that leads to a spoke resource.", + "id": "NextHopSpoke", + "properties": { + "siteToSiteDataTransfer": { + "description": "Indicates whether site-to-site data transfer is allowed for this spoke resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). Whether this route is accessible to other hybrid spokes with site-to-site data transfer enabled. If this is false, the route is only accessible to VPC spokes of the connected Hub.", + "type": "boolean" + }, + "uri": { + "description": "The URI of the spoke resource.", + "type": "string" + } + }, + "type": "object" + }, "NextHopVPNTunnel": { "description": "A route next hop that leads to a VPN tunnel resource.", "id": "NextHopVPNTunnel", @@ -5007,6 +5145,10 @@ "$ref": "NextHopRouterApplianceInstance", "description": "Immutable. The next-hop Router appliance instance for packets on this route." }, + "nextHopSpoke": { + "$ref": "NextHopSpoke", + "description": "Immutable. The next-hop spoke for packets on this route." + }, "nextHopVpcNetwork": { "$ref": "NextHopVpcNetwork", "description": "Immutable. The destination VPC network for packets on this route." diff --git a/discovery/networkconnectivity-v1alpha1.json b/discovery/networkconnectivity-v1alpha1.json index f757487b4b..1bc66a9fb8 100644 --- a/discovery/networkconnectivity-v1alpha1.json +++ b/discovery/networkconnectivity-v1alpha1.json @@ -1122,7 +1122,7 @@ } } }, - "revision": "20250414", + "revision": "20250502", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AllocationOptions": { @@ -1130,7 +1130,7 @@ "id": "AllocationOptions", "properties": { "allocationStrategy": { - "description": "Optional. Allocation strategy Not setting this field when the allocation is requested means an implementation defined strategy is used.", + "description": "Optional. Allocation strategy. Not setting this field when the allocation is requested means an implementation defined strategy is used.", "enum": [ "ALLOCATION_STRATEGY_UNSPECIFIED", "RANDOM", diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json index 4b21bbe997..840d725778 100644 --- a/discovery/networksecurity-v1.json +++ b/discovery/networksecurity-v1.json @@ -4908,7 +4908,7 @@ } } }, - "revision": "20250416", + "revision": "20250428", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5225,7 +5225,7 @@ "id": "AuthzPolicyAuthzRuleFromRequestSource", "properties": { "principals": { - "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the forwarding rule or Gateway. For Application Load Balancers, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or SPIFFE ID, or the subject field in the client's certificate. For Cloud Service Mesh, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or the subject field in the client's certificate. The match can be exact, prefix, suffix, or a substring match. One of exact, prefix, suffix, or contains must be specified. Limited to 5 principals.", + "description": "Optional. A list of identities derived from the client's certificate. This field is under development and we don't recommend using it at this time. Limited to 5 principals.", "items": { "$ref": "AuthzPolicyAuthzRuleStringMatch" }, diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index 3e821b7175..f2a974d446 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -5070,7 +5070,7 @@ } } }, - "revision": "20250416", + "revision": "20250428", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5387,7 +5387,7 @@ "id": "AuthzPolicyAuthzRuleFromRequestSource", "properties": { "principals": { - "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the forwarding rule or Gateway. For Application Load Balancers, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or SPIFFE ID, or the subject field in the client's certificate. For Cloud Service Mesh, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or the subject field in the client's certificate. The match can be exact, prefix, suffix, or a substring match. One of exact, prefix, suffix, or contains must be specified. Limited to 5 principals.", + "description": "Optional. A list of identities derived from the client's certificate. This field is under development and we don't recommend using it at this time. Limited to 5 principals.", "items": { "$ref": "AuthzPolicyAuthzRuleStringMatch" }, diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 03343b7cab..1e5f3d8e91 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -2184,6 +2184,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the parameters of a single ServiceBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.serviceBindings.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the ServiceBinding resource. It matches pattern `projects/*/locations/*/serviceBindings/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the ServiceBinding resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ServiceBinding" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -2970,7 +3004,7 @@ } } }, - "revision": "20250423", + "revision": "20250508", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 8fd9f1902e..6da01a9c2b 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -2093,6 +2093,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the parameters of a single ServiceBinding.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.serviceBindings.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the ServiceBinding resource. It matches pattern `projects/*/locations/*/serviceBindings/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the ServiceBinding resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "ServiceBinding" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -2879,7 +2913,7 @@ } } }, - "revision": "20250423", + "revision": "20250508", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuthzExtension": { diff --git a/discovery/notebooks-v1.json b/discovery/notebooks-v1.json index 2003a14f17..36a9f4454a 100644 --- a/discovery/notebooks-v1.json +++ b/discovery/notebooks-v1.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", @@ -2008,7 +2014,7 @@ } } }, - "revision": "20241204", + "revision": "20250430", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index 4ac42a5a0a..a5ef13d52a 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -143,6 +143,12 @@ "name" ], "parameters": { + "extraLocationTypes": { + "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "location": "query", + "repeated": true, + "type": "string" + }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", @@ -904,7 +910,7 @@ } } }, - "revision": "20250319", + "revision": "20250507", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1071,21 +1077,13 @@ "description": "Optional. Defines the type of technology used by the confidential instance.", "enum": [ "CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", - "SEV", - "SEV_SNP", - "TDX" + "SEV" ], "enumDescriptions": [ "No type specified. Do not use this value.", - "AMD Secure Encrypted Virtualization.", - "AMD Secure Encrypted Virtualization - Secure Nested Paging.", - "Intel Trust Domain eXtension." + "AMD Secure Encrypted Virtualization." ], "type": "string" - }, - "enableConfidentialCompute": { - "description": "Optional. Defines whether the instance should have confidential compute enabled.", - "type": "boolean" } }, "type": "object" @@ -1385,6 +1383,10 @@ }, "type": "array" }, + "reservationAffinity": { + "$ref": "ReservationAffinity", + "description": "Optional. Specifies the reservations that this instance can consume from." + }, "serviceAccounts": { "description": "Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.", "items": { @@ -1446,6 +1448,10 @@ "description": "Optional. If true, the notebook instance will not register with the proxy.", "type": "boolean" }, + "enableDeletionProtection": { + "description": "Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance.", + "type": "boolean" + }, "enableThirdPartyIdentity": { "description": "Optional. Flag that specifies that a notebook can be accessed with third party identity provider.", "type": "boolean" @@ -1487,7 +1493,7 @@ "type": "string" }, "instanceOwners": { - "description": "Optional. Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.", + "description": "Optional. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.", "items": { "type": "string" }, @@ -1819,6 +1825,40 @@ }, "type": "object" }, + "ReservationAffinity": { + "description": "A reservation that an instance can consume from.", + "id": "ReservationAffinity", + "properties": { + "consumeReservationType": { + "description": "Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples.", + "enum": [ + "RESERVATION_UNSPECIFIED", + "RESERVATION_NONE", + "RESERVATION_ANY", + "RESERVATION_SPECIFIC" + ], + "enumDescriptions": [ + "Default type.", + "Do not consume from any allocated capacity.", + "Consume any reservation available.", + "Must consume from a specific reservation. Must specify key value fields for specifying the reservations." + ], + "type": "string" + }, + "key": { + "description": "Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.", + "type": "string" + }, + "values": { + "description": "Optional. Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or \"projects/different-project/reservations/some-reservation-name\" to target a shared reservation in the same zone but in a different project.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ResetInstanceRequest": { "description": "Request for resetting a notebook instance", "id": "ResetInstanceRequest", @@ -1902,7 +1942,7 @@ "id": "ShieldedInstanceConfig", "properties": { "enableIntegrityMonitoring": { - "description": "Optional. Defines whether the VM instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the VM instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the VM instance is created. Enabled by default.", + "description": "Optional. Defines whether the VM instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the VM instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the VM instance is created.", "type": "boolean" }, "enableSecureBoot": { @@ -1910,7 +1950,7 @@ "type": "boolean" }, "enableVtpm": { - "description": "Optional. Defines whether the VM instance has the vTPM enabled. Enabled by default.", + "description": "Optional. Defines whether the VM instance has the vTPM enabled.", "type": "boolean" } }, diff --git a/discovery/ondemandscanning-v1.json b/discovery/ondemandscanning-v1.json index 0ed8e41e2d..e9d5dc9271 100644 --- a/discovery/ondemandscanning-v1.json +++ b/discovery/ondemandscanning-v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20250321", + "revision": "20250505", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1307,6 +1307,10 @@ }, "type": "array" }, + "chainId": { + "description": "The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid", + "type": "string" + }, "command": { "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", "type": "string" @@ -1647,6 +1651,10 @@ }, "type": "array" }, + "chainId": { + "description": "The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid", + "type": "string" + }, "command": { "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", "type": "string" @@ -1870,7 +1878,8 @@ "COMPLIANCE", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -1885,7 +1894,8 @@ "This represents a Compliance Note", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", - "This represents an SBOM Reference." + "This represents an SBOM Reference.", + "This represents a secret." ], "type": "string" }, @@ -1913,6 +1923,10 @@ "$ref": "SBOMReferenceOccurrence", "description": "Describes a specific SBOM reference occurrences." }, + "secret": { + "$ref": "SecretOccurrence", + "description": "Describes a secret." + }, "updateTime": { "description": "Output only. The time this occurrence was last updated.", "format": "google-datetime", @@ -2056,7 +2070,7 @@ "NPM packages.", "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", - "Rust packages from Cargo (Github ecosystem is `RUST`).", + "Rust packages from Cargo (GitHub ecosystem is `RUST`).", "PHP packages from Composer package manager.", "Swift packages from Swift Package Manager (SwiftPM)." ], @@ -2516,6 +2530,84 @@ }, "type": "object" }, + "SecretLocation": { + "description": "The location of the secret.", + "id": "SecretLocation", + "properties": { + "fileLocation": { + "$ref": "GrafeasV1FileLocation", + "description": "The secret is found from a file." + } + }, + "type": "object" + }, + "SecretOccurrence": { + "description": "The occurrence provides details of a secret.", + "id": "SecretOccurrence", + "properties": { + "kind": { + "description": "Required. Type of secret.", + "enum": [ + "SECRET_KIND_UNSPECIFIED", + "SECRET_KIND_UNKNOWN", + "SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY" + ], + "enumDescriptions": [ + "Unspecified", + "The secret kind is unknown.", + "A GCP service account key per: https://cloud.google.com/iam/docs/creating-managing-service-account-keys" + ], + "type": "string" + }, + "locations": { + "description": "Optional. Locations where the secret is detected.", + "items": { + "$ref": "SecretLocation" + }, + "type": "array" + }, + "statuses": { + "description": "Optional. Status of the secret.", + "items": { + "$ref": "SecretStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretStatus": { + "description": "The status of the secret with a timestamp.", + "id": "SecretStatus", + "properties": { + "message": { + "description": "Optional. Optional message about the status code.", + "type": "string" + }, + "status": { + "description": "Optional. The status of the secret.", + "enum": [ + "STATUS_UNSPECIFIED", + "UNKNOWN", + "VALID", + "INVALID" + ], + "enumDescriptions": [ + "Unspecified", + "The status of the secret is unknown.", + "The secret is valid.", + "The secret is invalid." + ], + "type": "string" + }, + "updateTime": { + "description": "Optional. The time the secret status was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "Signature": { "description": "Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from `public_key_id` to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature `public_key_id` as anything more than a key lookup hint. The `public_key_id` DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The `public_key_id` is not recognized by the verifier. * The public key that `public_key_id` refers to does not verify the signature with respect to the payload. The `signature` contents SHOULD NOT be \"attached\" (where the payload is included with the serialized `signature` bytes). Verifiers MUST ignore any \"attached\" payload and only verify signatures with respect to explicitly provided payload (e.g. a `payload` field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature).", "id": "Signature", diff --git a/discovery/ondemandscanning-v1beta1.json b/discovery/ondemandscanning-v1beta1.json index 7ab008c1eb..504bada0fc 100644 --- a/discovery/ondemandscanning-v1beta1.json +++ b/discovery/ondemandscanning-v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20250321", + "revision": "20250505", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1302,6 +1302,10 @@ }, "type": "array" }, + "chainId": { + "description": "The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid", + "type": "string" + }, "command": { "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", "type": "string" @@ -1642,6 +1646,10 @@ }, "type": "array" }, + "chainId": { + "description": "The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid", + "type": "string" + }, "command": { "description": "The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built.", "type": "string" @@ -1865,7 +1873,8 @@ "COMPLIANCE", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", - "SBOM_REFERENCE" + "SBOM_REFERENCE", + "SECRET" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -1880,7 +1889,8 @@ "This represents a Compliance Note", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", - "This represents an SBOM Reference." + "This represents an SBOM Reference.", + "This represents a secret." ], "type": "string" }, @@ -1908,6 +1918,10 @@ "$ref": "SBOMReferenceOccurrence", "description": "Describes a specific SBOM reference occurrences." }, + "secret": { + "$ref": "SecretOccurrence", + "description": "Describes a secret." + }, "updateTime": { "description": "Output only. The time this occurrence was last updated.", "format": "google-datetime", @@ -2051,7 +2065,7 @@ "NPM packages.", "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", - "Rust packages from Cargo (Github ecosystem is `RUST`).", + "Rust packages from Cargo (GitHub ecosystem is `RUST`).", "PHP packages from Composer package manager.", "Swift packages from Swift Package Manager (SwiftPM)." ], @@ -2511,6 +2525,84 @@ }, "type": "object" }, + "SecretLocation": { + "description": "The location of the secret.", + "id": "SecretLocation", + "properties": { + "fileLocation": { + "$ref": "GrafeasV1FileLocation", + "description": "The secret is found from a file." + } + }, + "type": "object" + }, + "SecretOccurrence": { + "description": "The occurrence provides details of a secret.", + "id": "SecretOccurrence", + "properties": { + "kind": { + "description": "Required. Type of secret.", + "enum": [ + "SECRET_KIND_UNSPECIFIED", + "SECRET_KIND_UNKNOWN", + "SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY" + ], + "enumDescriptions": [ + "Unspecified", + "The secret kind is unknown.", + "A GCP service account key per: https://cloud.google.com/iam/docs/creating-managing-service-account-keys" + ], + "type": "string" + }, + "locations": { + "description": "Optional. Locations where the secret is detected.", + "items": { + "$ref": "SecretLocation" + }, + "type": "array" + }, + "statuses": { + "description": "Optional. Status of the secret.", + "items": { + "$ref": "SecretStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretStatus": { + "description": "The status of the secret with a timestamp.", + "id": "SecretStatus", + "properties": { + "message": { + "description": "Optional. Optional message about the status code.", + "type": "string" + }, + "status": { + "description": "Optional. The status of the secret.", + "enum": [ + "STATUS_UNSPECIFIED", + "UNKNOWN", + "VALID", + "INVALID" + ], + "enumDescriptions": [ + "Unspecified", + "The status of the secret is unknown.", + "The secret is valid.", + "The secret is invalid." + ], + "type": "string" + }, + "updateTime": { + "description": "Optional. The time the secret status was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "Signature": { "description": "Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from `public_key_id` to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature `public_key_id` as anything more than a key lookup hint. The `public_key_id` DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The `public_key_id` is not recognized by the verifier. * The public key that `public_key_id` refers to does not verify the signature with respect to the payload. The `signature` contents SHOULD NOT be \"attached\" (where the payload is included with the serialized `signature` bytes). Verifiers MUST ignore any \"attached\" payload and only verify signatures with respect to explicitly provided payload (e.g. a `payload` field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature).", "id": "Signature", diff --git a/discovery/oracledatabase-v1.json b/discovery/oracledatabase-v1.json index c978220e5c..a497a9d883 100644 --- a/discovery/oracledatabase-v1.json +++ b/discovery/oracledatabase-v1.json @@ -970,7 +970,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}.", + "description": "Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. .", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$", "required": true, @@ -1080,6 +1080,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Only the shape and gi_version fields are supported in this format: `shape=\"{shape}\"`.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "format": "int32", @@ -1237,7 +1242,7 @@ } } }, - "revision": "20250428", + "revision": "20250509", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -1271,7 +1276,7 @@ "type": "string" }, "cidr": { - "description": "Optional. The subnet CIDR range for the Autonmous Database.", + "description": "Optional. The subnet CIDR range for the Autonomous Database.", "type": "string" }, "createTime": { @@ -3897,7 +3902,7 @@ "type": "object" }, "SourceConfig": { - "description": "The source configuration for the standby Autonomnous Database.", + "description": "The source configuration for the standby Autonomous Database.", "id": "SourceConfig", "properties": { "automaticBackupsReplicationEnabled": { diff --git a/discovery/osconfig-v1.json b/discovery/osconfig-v1.json index 741a5ea8e6..97125259e8 100644 --- a/discovery/osconfig-v1.json +++ b/discovery/osconfig-v1.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20250323", + "revision": "20250511", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -2055,6 +2055,13 @@ }, "type": "object" }, + "MessageSet": { + "deprecated": true, + "description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, "MonthlySchedule": { "description": "Represents a monthly schedule. An example of a valid monthly schedule is \"on the third Tuesday of the month\" or \"on the 15th of the month\".", "id": "MonthlySchedule", @@ -3583,6 +3590,35 @@ }, "type": "object" }, + "StatusProto": { + "description": "Wire-format for a Status object", + "id": "StatusProto", + "properties": { + "canonicalCode": { + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;", + "type": "string" + }, + "messageSet": { + "$ref": "MessageSet", + "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" + }, + "space": { + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", + "type": "string" + } + }, + "type": "object" + }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", diff --git a/discovery/osconfig-v1alpha.json b/discovery/osconfig-v1alpha.json index d7451d5a52..036bc01f93 100644 --- a/discovery/osconfig-v1alpha.json +++ b/discovery/osconfig-v1alpha.json @@ -707,7 +707,7 @@ } } }, - "revision": "20250323", + "revision": "20250511", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { @@ -1596,6 +1596,13 @@ }, "type": "object" }, + "MessageSet": { + "deprecated": true, + "description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, "OSPolicy": { "description": "An OS policy defines the desired state configuration for a VM.", "id": "OSPolicy", @@ -2680,6 +2687,35 @@ }, "type": "object" }, + "StatusProto": { + "description": "Wire-format for a Status object", + "id": "StatusProto", + "properties": { + "canonicalCode": { + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;", + "type": "string" + }, + "messageSet": { + "$ref": "MessageSet", + "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" + }, + "space": { + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", + "type": "string" + } + }, + "type": "object" + }, "VulnerabilityReport": { "description": "This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see [Vulnerability reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports).", "id": "VulnerabilityReport", diff --git a/discovery/osconfig-v1beta.json b/discovery/osconfig-v1beta.json index 7cad5c879b..91e74eadf8 100644 --- a/discovery/osconfig-v1beta.json +++ b/discovery/osconfig-v1beta.json @@ -689,7 +689,7 @@ } } }, - "revision": "20250323", + "revision": "20250511", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { @@ -1365,6 +1365,13 @@ }, "type": "object" }, + "MessageSet": { + "deprecated": true, + "description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, "MonthlySchedule": { "description": "Represents a monthly schedule. An example of a valid monthly schedule is \"on the third Tuesday of the month\" or \"on the 15th of the month\".", "id": "MonthlySchedule", @@ -2351,6 +2358,35 @@ }, "type": "object" }, + "StatusProto": { + "description": "Wire-format for a Status object", + "id": "StatusProto", + "properties": { + "canonicalCode": { + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;", + "type": "string" + }, + "messageSet": { + "$ref": "MessageSet", + "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" + }, + "space": { + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", + "type": "string" + } + }, + "type": "object" + }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", diff --git a/discovery/osconfig-v2.json b/discovery/osconfig-v2.json index c41e746db0..6dfe0c64c9 100644 --- a/discovery/osconfig-v2.json +++ b/discovery/osconfig-v2.json @@ -274,7 +274,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -591,7 +591,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -908,7 +908,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1057,7 +1057,7 @@ } } }, - "revision": "20250323", + "revision": "20250511", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1504,6 +1504,13 @@ }, "type": "object" }, + "MessageSet": { + "deprecated": true, + "description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, "OSPolicy": { "description": "An OS policy defines the desired state configuration for a VM.", "id": "OSPolicy", @@ -2309,6 +2316,35 @@ } }, "type": "object" + }, + "StatusProto": { + "description": "Wire-format for a Status object", + "id": "StatusProto", + "properties": { + "canonicalCode": { + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;", + "type": "string" + }, + "messageSet": { + "$ref": "MessageSet", + "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" + }, + "space": { + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/osconfig-v2beta.json b/discovery/osconfig-v2beta.json index a2a8bce880..671f91e27c 100644 --- a/discovery/osconfig-v2beta.json +++ b/discovery/osconfig-v2beta.json @@ -274,7 +274,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -591,7 +591,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -908,7 +908,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", + "description": "Optional. The list of fields to merge into the existing policy orchestrator. A special [\"*\"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1057,7 +1057,7 @@ } } }, - "revision": "20250323", + "revision": "20250511", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1504,6 +1504,13 @@ }, "type": "object" }, + "MessageSet": { + "deprecated": true, + "description": "This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a \"bridge\" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments.", + "id": "MessageSet", + "properties": {}, + "type": "object" + }, "OSPolicy": { "description": "An OS policy defines the desired state configuration for a VM.", "id": "OSPolicy", @@ -2309,6 +2316,35 @@ } }, "type": "object" + }, + "StatusProto": { + "description": "Wire-format for a Status object", + "id": "StatusProto", + "properties": { + "canonicalCode": { + "description": "copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6;", + "format": "int32", + "type": "integer" + }, + "code": { + "description": "Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1;", + "format": "int32", + "type": "integer" + }, + "message": { + "description": "Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3;", + "type": "string" + }, + "messageSet": { + "$ref": "MessageSet", + "description": "message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5;" + }, + "space": { + "description": "copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/oslogin-v1alpha.json b/discovery/oslogin-v1alpha.json index e427be6475..55ea9474ba 100644 --- a/discovery/oslogin-v1alpha.json +++ b/discovery/oslogin-v1alpha.json @@ -542,7 +542,7 @@ } } }, - "revision": "20250406", + "revision": "20250504", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { @@ -556,7 +556,7 @@ "id": "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest", "properties": { "appEngineInstance": { - "description": "The App Engine instance to sign the SSH public key for. Expected format: services/{service}/versions/{version}/instances/{instance}", + "description": "The App Engine instance to sign the SSH public key for. Expected format: apps/{app}/services/{service}/versions/{version}/instances/{instance}", "type": "string" }, "computeInstance": { diff --git a/discovery/oslogin-v1beta.json b/discovery/oslogin-v1beta.json index 6a9d33f199..9e66cbb0d9 100644 --- a/discovery/oslogin-v1beta.json +++ b/discovery/oslogin-v1beta.json @@ -512,7 +512,7 @@ } } }, - "revision": "20250406", + "revision": "20250504", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { @@ -526,7 +526,7 @@ "id": "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest", "properties": { "appEngineInstance": { - "description": "The App Engine instance to sign the SSH public key for. Expected format: services/{service}/versions/{version}/instances/{instance}", + "description": "The App Engine instance to sign the SSH public key for. Expected format: apps/{app}/services/{service}/versions/{version}/instances/{instance}", "type": "string" }, "computeInstance": { diff --git a/discovery/people-v1.json b/discovery/people-v1.json index 624fd4a540..7a3c34d3ea 100644 --- a/discovery/people-v1.json +++ b/discovery/people-v1.json @@ -998,7 +998,7 @@ ] }, "updateContact": { - "description": "Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `\"failedPrecondition\"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.", + "description": "Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `\"failedPrecondition\"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. If making sequential updates to the same person, the etag from the `updateContact` response should be used to avoid failures. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.", "flatPath": "v1/people/{peopleId}:updateContact", "httpMethod": "PATCH", "id": "people.people.updateContact", @@ -1190,7 +1190,7 @@ } } }, - "revision": "20240320", + "revision": "20250513", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/discovery/places-v1.json b/discovery/places-v1.json index 8fd29b9ef6..727aeb8eaa 100644 --- a/discovery/places-v1.json +++ b/discovery/places-v1.json @@ -280,7 +280,7 @@ } } }, - "revision": "20250429", + "revision": "20250506", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1497,7 +1497,7 @@ "type": "string" }, "photosUri": { - "description": "A link to show photos of this place. This link is currently not supported on Google Maps Mobile and only works on the web version of Google Maps.", + "description": "A link to show reviews of this place on Google Maps.", "type": "string" }, "placeUri": { @@ -1505,11 +1505,11 @@ "type": "string" }, "reviewsUri": { - "description": "A link to show reviews of this place. This link is currently not supported on Google Maps Mobile and only works on the web version of Google Maps.", + "description": "A link to show reviews of this place on Google Maps.", "type": "string" }, "writeAReviewUri": { - "description": "A link to write a review for this place. This link is currently not supported on Google Maps Mobile and only works on the web version of Google Maps.", + "description": "A link to write a review for this place on Google Maps.", "type": "string" } }, @@ -1757,6 +1757,10 @@ "description": "A link where users can flag a problem with the summary.", "type": "string" }, + "reviewsUri": { + "description": "A link to show reviews of this place on Google Maps.", + "type": "string" + }, "text": { "$ref": "GoogleTypeLocalizedText", "description": "The summary of user reviews." @@ -1846,27 +1850,6 @@ "text": { "$ref": "GoogleTypeLocalizedText", "description": "The localized text of the review." - }, - "visitDate": { - "$ref": "GoogleMapsPlacesV1ReviewVisitDate", - "description": "The date when the author visited the place. This is trucated to month." - } - }, - "type": "object" - }, - "GoogleMapsPlacesV1ReviewVisitDate": { - "description": "The date when the author visited the place. This is trucated to month.", - "id": "GoogleMapsPlacesV1ReviewVisitDate", - "properties": { - "month": { - "description": "The month the author visited the place, e.g. 4. The value is between 1 and 12.", - "format": "int32", - "type": "integer" - }, - "year": { - "description": "The year the author visited the place, e.g. 2025.", - "format": "int32", - "type": "integer" } }, "type": "object" diff --git a/discovery/playintegrity-v1.json b/discovery/playintegrity-v1.json index 330af92631..d6a83ebd73 100644 --- a/discovery/playintegrity-v1.json +++ b/discovery/playintegrity-v1.json @@ -166,11 +166,39 @@ "scopes": [ "https://www.googleapis.com/auth/playintegrity" ] + }, + "decodePcIntegrityToken": { + "description": "Decodes the PC integrity token and returns the PC token payload.", + "flatPath": "v1/{v1Id}:decodePcIntegrityToken", + "httpMethod": "POST", + "id": "playintegrity.decodePcIntegrityToken", + "parameterOrder": [ + "packageName" + ], + "parameters": { + "packageName": { + "description": "Package name of the app the attached integrity token belongs to.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+packageName}:decodePcIntegrityToken", + "request": { + "$ref": "DecodePcIntegrityTokenRequest" + }, + "response": { + "$ref": "DecodePcIntegrityTokenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/playintegrity" + ] } } } }, - "revision": "20250223", + "revision": "20250514", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -324,6 +352,28 @@ }, "type": "object" }, + "DecodePcIntegrityTokenRequest": { + "description": "Request to decode the PC integrity token.", + "id": "DecodePcIntegrityTokenRequest", + "properties": { + "integrityToken": { + "description": "Encoded integrity token.", + "type": "string" + } + }, + "type": "object" + }, + "DecodePcIntegrityTokenResponse": { + "description": "Response containing the decoded PC integrity payload.", + "id": "DecodePcIntegrityTokenResponse", + "properties": { + "tokenPayloadExternal": { + "$ref": "PcTokenPayloadExternal", + "description": "Plain token payload generated from the decoded integrity token." + } + }, + "type": "object" + }, "DeviceAttributes": { "description": "Contains information about the device for which the integrity token was generated, e.g. Android SDK version.", "id": "DeviceAttributes", @@ -445,6 +495,63 @@ }, "type": "object" }, + "PcDeviceIntegrity": { + "description": "Contains the device attestation information.", + "id": "PcDeviceIntegrity", + "properties": { + "deviceRecognitionVerdict": { + "description": "Details about the integrity of the device the app is running on.", + "items": { + "enum": [ + "DEVICE_RECOGNITION_VERDICT_UNSPECIFIED", + "MEETS_PC_INTEGRITY" + ], + "enumDescriptions": [ + "Unspecified device integrity.", + "App is running on Windows Device with Google Desktop Services." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "PcRequestDetails": { + "description": "Contains the integrity request information.", + "id": "PcRequestDetails", + "properties": { + "requestHash": { + "description": "Request hash that was provided in the request.", + "type": "string" + }, + "requestPackageName": { + "description": "Required. Application package name this attestation was requested for. Note: This field makes no guarantees or promises on the caller integrity.", + "type": "string" + }, + "requestTime": { + "description": "Required. Timestamp, of the integrity application request.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "PcTokenPayloadExternal": { + "description": "Contains PC device attestation details.", + "id": "PcTokenPayloadExternal", + "properties": { + "deviceIntegrity": { + "$ref": "PcDeviceIntegrity", + "description": "Required. Details about the device integrity." + }, + "requestDetails": { + "$ref": "PcRequestDetails", + "description": "Required. Details about the integrity request." + } + }, + "type": "object" + }, "RecentDeviceActivity": { "description": "Recent device activity can help developers identify devices that have exhibited hyperactive attestation activity, which could be a sign of an attack or token farming.", "id": "RecentDeviceActivity", diff --git a/discovery/realtimebidding-v1.json b/discovery/realtimebidding-v1.json index b3c8c196ad..88bd5a68ad 100644 --- a/discovery/realtimebidding-v1.json +++ b/discovery/realtimebidding-v1.json @@ -1305,7 +1305,7 @@ } } }, - "revision": "20250306", + "revision": "20250508", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -2294,6 +2294,12 @@ "OPENRTB_JSON", "OPENRTB_PROTOBUF" ], + "enumDeprecated": [ + false, + true, + false, + false + ], "enumDescriptions": [ "Placeholder for undefined bid protocol. This value should not be used.", "Google RTB protocol / Protobuf encoding.", diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json index a5d65f6547..675bbb4eb5 100644 --- a/discovery/recaptchaenterprise-v1.json +++ b/discovery/recaptchaenterprise-v1.json @@ -786,7 +786,7 @@ } } }, - "revision": "20250427", + "revision": "20250504", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1412,6 +1412,14 @@ "description": "Output only. Assessment of this transaction for risk of being part of a card testing attack.", "readOnly": true }, + "riskReasons": { + "description": "Output only. Reasons why the transaction is probably fraudulent and received a high transaction risk score.", + "items": { + "$ref": "GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentRiskReason" + }, + "readOnly": true, + "type": "array" + }, "stolenInstrumentVerdict": { "$ref": "GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict", "description": "Output only. Assessment of this transaction for risk of a stolen instrument.", @@ -1452,6 +1460,34 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentRiskReason": { + "description": "Risk reasons applicable to the Fraud Prevention assessment.", + "id": "GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentRiskReason", + "properties": { + "reason": { + "description": "Output only. Risk reasons applicable to the Fraud Prevention assessment.", + "enum": [ + "REASON_UNSPECIFIED", + "HIGH_TRANSACTION_VELOCITY", + "EXCESSIVE_ENUMERATION_PATTERN", + "SHORT_IDENTITY_HISTORY", + "GEOLOCATION_DISCREPANCY", + "ASSOCIATED_WITH_FRAUD_CLUSTER" + ], + "enumDescriptions": [ + "Default unspecified type.", + "A suspiciously high number of recent transactions have used identifiers present in this transaction.", + "User is cycling through a suspiciously large number of identifiers, suggesting enumeration or validation attacks within a potential fraud network.", + "User has a short history or no history in the reCAPTCHA network, suggesting the possibility of synthetic identity generation.", + "Identifiers used in this transaction originate from an unusual or conflicting set of geolocations.", + "This transaction is linked to a cluster of known fraudulent activity." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict": { "description": "Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase.", "id": "GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict", diff --git a/discovery/reseller-v1.json b/discovery/reseller-v1.json index a55bcff5d2..f379348a0f 100644 --- a/discovery/reseller-v1.json +++ b/discovery/reseller-v1.json @@ -499,7 +499,7 @@ ], "parameters": { "action": { - "description": "The intented insert action. The usage of this field is governed by certain policies which are being developed & tested currently. Hence, these might not work as intended. Once this is fully tested & available to consume, we will share more information about its usage, limitations and policy documentation.", + "description": "The intented insert action. Advised to set this when the customer already has a subscription for a different SKU in the same product.", "enum": [ "actionUnspecified", "buy", @@ -525,7 +525,7 @@ "type": "string" }, "sourceSkuId": { - "description": "The sku_id of the existing subscription to be upgraded or downgraded. This is required when action is SWITCH. The usage of this field is governed by certain policies which are being developed & tested currently. Hence, these might not work as intended. Once this is fully tested & available to consume, we will share more information about its usage, limitations and policy documentation.", + "description": "The sku_id of the existing subscription to be upgraded or downgraded. This is required when action is SWITCH.", "location": "query", "type": "string" } @@ -651,7 +651,7 @@ } } }, - "revision": "20250419", + "revision": "20250511", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index 8856901841..6e0a1e20cc 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -2223,7 +2223,7 @@ } } }, - "revision": "20250417", + "revision": "20250515", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3216,6 +3216,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2DoubleList": { + "description": "A message with a list of double values.", + "id": "GoogleCloudRetailV2DoubleList", + "properties": { + "values": { + "description": "The list of double values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2ExperimentInfo": { "description": "Metadata for active A/B testing experiment.", "id": "GoogleCloudRetailV2ExperimentInfo", @@ -3777,24 +3792,6 @@ "description": "Optional. Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", "type": "object" }, - "availability": { - "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details.", - "enum": [ - "AVAILABILITY_UNSPECIFIED", - "IN_STOCK", - "OUT_OF_STOCK", - "PREORDER", - "BACKORDER" - ], - "enumDescriptions": [ - "Default product availability. Default to Availability.IN_STOCK if unset.", - "Product in stock.", - "Product out of stock.", - "Product that is in pre-order state.", - "Product that is back-ordered (i.e. temporarily out of stock)." - ], - "type": "string" - }, "fulfillmentTypes": { "description": "Optional. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * \"pickup-in-store\" * \"ship-to-store\" * \"same-day-delivery\" * \"next-day-delivery\" * \"custom-type-1\" * \"custom-type-2\" * \"custom-type-3\" * \"custom-type-4\" * \"custom-type-5\" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.", "items": { @@ -5773,6 +5770,13 @@ "description": "If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product fields. If matched attributes cannot be determined, this map will be empty. For example, a key \"sku1\" with field mask \"products.color_info\" indicates there is a match between \"sku1\" ColorInfo and the query.", "type": "object" }, + "modelScores": { + "additionalProperties": { + "$ref": "GoogleCloudRetailV2DoubleList" + }, + "description": "Google provided available scores.", + "type": "object" + }, "personalLabels": { "description": "Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that this product has been purchased before.", "items": { @@ -6612,8 +6616,14 @@ "description": "Merchant Center Feed filter criterion.", "id": "GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter", "properties": { + "dataSourceId": { + "description": "AFM data source ID.", + "format": "int64", + "type": "string" + }, "primaryFeedId": { - "description": "Merchant Center primary feed ID.", + "deprecated": true, + "description": "Merchant Center primary feed ID. Deprecated: use data_source_id instead.", "format": "int64", "type": "string" }, diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index 66063c9e44..fb5dbb40e5 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -2800,7 +2800,7 @@ } } }, - "revision": "20250417", + "revision": "20250515", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4694,11 +4694,6 @@ "$ref": "GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch" }, "type": "array" - }, - "rephrasedQuery": { - "deprecated": true, - "description": "This field is deprecated. Please find the refinded_query from search response when using CONVERSATIONAL_FILTER_ONLY mode in ConversationalSearchResponse.refined_search instead. The rephrased query based on the user's query and the conversation history. It can be used to fetch the relevant search results.", - "type": "string" } }, "type": "object" @@ -4829,6 +4824,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaDoubleList": { + "description": "A message with a list of double values.", + "id": "GoogleCloudRetailV2alphaDoubleList", + "properties": { + "values": { + "description": "The list of double values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaEnrollSolutionMetadata": { "description": "Metadata related to the EnrollSolution method. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2alphaEnrollSolutionMetadata", @@ -5751,8 +5761,14 @@ "description": "Merchant Center Feed filter criterion.", "id": "GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter", "properties": { + "dataSourceId": { + "description": "AFM data source ID.", + "format": "int64", + "type": "string" + }, "primaryFeedId": { - "description": "Merchant Center primary feed ID.", + "deprecated": true, + "description": "Merchant Center primary feed ID. Deprecated: use data_source_id instead.", "format": "int64", "type": "string" }, @@ -5767,8 +5783,14 @@ "description": "Merchant Center Feed filter criterion.", "id": "GoogleCloudRetailV2alphaMerchantCenterFeedFilter", "properties": { + "dataSourceId": { + "description": "AFM data source ID.", + "format": "int64", + "type": "string" + }, "primaryFeedId": { - "description": "Merchant Center primary feed ID.", + "deprecated": true, + "description": "Merchant Center primary feed ID. Deprecated: use data_source_id instead.", "format": "int64", "type": "string" }, @@ -7912,6 +7934,13 @@ "description": "If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product fields. If matched attributes cannot be determined, this map will be empty. For example, a key \"sku1\" with field mask \"products.color_info\" indicates there is a match between \"sku1\" ColorInfo and the query.", "type": "object" }, + "modelScores": { + "additionalProperties": { + "$ref": "GoogleCloudRetailV2alphaDoubleList" + }, + "description": "Google provided available scores.", + "type": "object" + }, "personalLabels": { "description": "Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that this product has been purchased before.", "items": { diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 4b071ac55d..1eab04ee72 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -2368,7 +2368,7 @@ } } }, - "revision": "20250417", + "revision": "20250515", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3461,8 +3461,14 @@ "description": "Merchant Center Feed filter criterion.", "id": "GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter", "properties": { + "dataSourceId": { + "description": "AFM data source ID.", + "format": "int64", + "type": "string" + }, "primaryFeedId": { - "description": "Merchant Center primary feed ID.", + "deprecated": true, + "description": "Merchant Center primary feed ID. Deprecated: use data_source_id instead.", "format": "int64", "type": "string" }, @@ -4875,6 +4881,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaDoubleList": { + "description": "A message with a list of double values.", + "id": "GoogleCloudRetailV2betaDoubleList", + "properties": { + "values": { + "description": "The list of double values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaExperimentInfo": { "description": "Metadata for active A/B testing experiment.", "id": "GoogleCloudRetailV2betaExperimentInfo", @@ -5510,24 +5531,6 @@ "description": "Optional. Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", "type": "object" }, - "availability": { - "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details.", - "enum": [ - "AVAILABILITY_UNSPECIFIED", - "IN_STOCK", - "OUT_OF_STOCK", - "PREORDER", - "BACKORDER" - ], - "enumDescriptions": [ - "Default product availability. Default to Availability.IN_STOCK if unset.", - "Product in stock.", - "Product out of stock.", - "Product that is in pre-order state.", - "Product that is back-ordered (i.e. temporarily out of stock)." - ], - "type": "string" - }, "fulfillmentTypes": { "description": "Optional. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * \"pickup-in-store\" * \"ship-to-store\" * \"same-day-delivery\" * \"next-day-delivery\" * \"custom-type-1\" * \"custom-type-2\" * \"custom-type-3\" * \"custom-type-4\" * \"custom-type-5\" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.", "items": { @@ -5550,8 +5553,14 @@ "description": "Merchant Center Feed filter criterion.", "id": "GoogleCloudRetailV2betaMerchantCenterFeedFilter", "properties": { + "dataSourceId": { + "description": "AFM data source ID.", + "format": "int64", + "type": "string" + }, "primaryFeedId": { - "description": "Merchant Center primary feed ID.", + "deprecated": true, + "description": "Merchant Center primary feed ID. Deprecated: use data_source_id instead.", "format": "int64", "type": "string" }, @@ -7574,6 +7583,13 @@ "description": "If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product fields. If matched attributes cannot be determined, this map will be empty. For example, a key \"sku1\" with field mask \"products.color_info\" indicates there is a match between \"sku1\" ColorInfo and the query.", "type": "object" }, + "modelScores": { + "additionalProperties": { + "$ref": "GoogleCloudRetailV2betaDoubleList" + }, + "description": "Google provided available scores.", + "type": "object" + }, "personalLabels": { "description": "Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that this product has been purchased before.", "items": { diff --git a/discovery/run-v1.json b/discovery/run-v1.json index d319b2d195..fc2e5a1bc5 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -2790,13 +2790,104 @@ ] } } + }, + "workerpools": { + "methods": { + "getIamPolicy": { + "description": "Get the IAM Access Control policy currently in effect for the given worker pool. This result does not include any inherited policies.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workerpools/{workerpoolsId}:getIamPolicy", + "httpMethod": "GET", + "id": "run.projects.locations.workerpools.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workerpools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the IAM Access control policy for the specified worker pool. Overwrites any existing policy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workerpools/{workerpoolsId}:setIamPolicy", + "httpMethod": "POST", + "id": "run.projects.locations.workerpools.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workerpools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified worker pool. There are no permissions required for making this API call.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workerpools/{workerpoolsId}:testIamPermissions", + "httpMethod": "POST", + "id": "run.projects.locations.workerpools.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/[^/]+/workerpools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } }, - "revision": "20250425", + "revision": "20250509", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 5e6b80f8e0..1786695642 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1631,6 +1631,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getIamPolicy": { + "description": "Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:getIamPolicy", + "httpMethod": "GET", + "id": "run.projects.locations.workerPools.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists WorkerPools. Results are sorted by creation time, descending.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools", @@ -1721,6 +1752,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setIamPolicy": { + "description": "Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing policy.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:setIamPolicy", + "httpMethod": "POST", + "id": "run.projects.locations.workerPools.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/workerPools/{workerPoolsId}:testIamPermissions", @@ -1863,7 +1922,7 @@ } } }, - "revision": "20250425", + "revision": "20250509", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -4798,30 +4857,6 @@ "description": "Optional. The total number of instances in manual scaling mode.", "format": "int32", "type": "integer" - }, - "maxInstanceCount": { - "description": "Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages.", - "format": "int32", - "type": "integer" - }, - "minInstanceCount": { - "description": "Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages.", - "format": "int32", - "type": "integer" - }, - "scalingMode": { - "description": "Optional. The scaling mode for the worker pool.", - "enum": [ - "SCALING_MODE_UNSPECIFIED", - "AUTOMATIC", - "MANUAL" - ], - "enumDescriptions": [ - "Unspecified.", - "Automatically scale between min and max instances.", - "Scale to exactly min instances and ignore the max instances." - ], - "type": "string" } }, "type": "object" diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index d47c2f3fc9..b57ca53623 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -5938,7 +5938,7 @@ } } }, - "revision": "20250411", + "revision": "20250519", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6967,7 +6967,7 @@ }, "end": { "$ref": "Position", - "description": "The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed.." + "description": "The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed." }, "fieldPath": { "description": "The path, in RFC 8901 JSON Pointer format, to the field that failed validation. This may be left empty if no specific field is affected.", @@ -6985,6 +6985,7 @@ "id": "CustomModuleValidationErrors", "properties": { "errors": { + "description": "The list of errors.", "items": { "$ref": "CustomModuleValidationError" }, @@ -7696,6 +7697,13 @@ "format": "int64", "type": "string" }, + "operations": { + "description": "Operation(s) performed on a file.", + "items": { + "$ref": "FileOperation" + }, + "type": "array" + }, "partiallyHashed": { "description": "True when the hash covers only a prefix of the file.", "type": "boolean" @@ -7716,6 +7724,33 @@ }, "type": "object" }, + "FileOperation": { + "description": "Operation(s) performed on a file.", + "id": "FileOperation", + "properties": { + "type": { + "description": "The type of the operation", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "OPEN", + "READ", + "RENAME", + "WRITE", + "EXECUTE" + ], + "enumDescriptions": [ + "The operation is unspecified.", + "Represents an open operation.", + "Represents a read operation.", + "Represents a rename operation.", + "Represents a write operation.", + "Represents an execute operation." + ], + "type": "string" + } + }, + "type": "object" + }, "Finding": { "description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "Finding", @@ -10399,6 +10434,13 @@ "format": "int64", "type": "string" }, + "operations": { + "description": "Operation(s) performed on a file.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2FileOperation" + }, + "type": "array" + }, "partiallyHashed": { "description": "True when the hash covers only a prefix of the file.", "type": "boolean" @@ -10419,6 +10461,33 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2FileOperation": { + "description": "Operation(s) performed on a file.", + "id": "GoogleCloudSecuritycenterV2FileOperation", + "properties": { + "type": { + "description": "The type of the operation", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "OPEN", + "READ", + "RENAME", + "WRITE", + "EXECUTE" + ], + "enumDescriptions": [ + "The operation is unspecified.", + "Represents an open operation.", + "Represents a read operation.", + "Represents a rename operation.", + "Represents a write operation.", + "Represents an execute operation." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Finding": { "description": "Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.", "id": "GoogleCloudSecuritycenterV2Finding", @@ -11114,7 +11183,8 @@ "CONTAINER", "DATA", "IDENTITY_AND_ACCESS", - "VULNERABILITY" + "VULNERABILITY", + "THREAT" ], "enumDescriptions": [ "Unspecified domain category.", @@ -11123,7 +11193,8 @@ "Issues in the container domain.", "Issues in the data domain.", "Issues in the identity and access domain.", - "Issues in the vulnerability domain." + "Issues in the vulnerability domain.", + "Issues in the threat domain." ], "type": "string" } @@ -11610,18 +11681,28 @@ "TECHNIQUE_UNSPECIFIED", "DATA_OBFUSCATION", "DATA_OBFUSCATION_STEGANOGRAPHY", + "OS_CREDENTIAL_DUMPING", + "OS_CREDENTIAL_DUMPING_PROC_FILESYSTEM", + "OS_CREDENTIAL_DUMPING_ETC_PASSWORD_AND_ETC_SHADOW", + "DATA_FROM_LOCAL_SYSTEM", "AUTOMATED_EXFILTRATION", "OBFUSCATED_FILES_OR_INFO", "STEGANOGRAPHY", "COMPILE_AFTER_DELIVERY", "COMMAND_OBFUSCATION", + "SCHEDULED_TRANSFER", + "SYSTEM_OWNER_USER_DISCOVERY", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", + "SCHEDULED_TASK_JOB_CRON", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", + "INPUT_CAPTURE", + "INPUT_CAPTURE_KEYLOGGING", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -11629,7 +11710,12 @@ "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL", + "INDICATOR_REMOVAL_CLEAR_LINUX_OR_MAC_SYSTEM_LOGS", + "INDICATOR_REMOVAL_CLEAR_COMMAND_HISTORY", "INDICATOR_REMOVAL_FILE_DELETION", + "INDICATOR_REMOVAL_TIMESTOMP", + "INDICATOR_REMOVAL_CLEAR_MAILBOX_DATA", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -11637,6 +11723,8 @@ "DEFAULT_ACCOUNTS", "LOCAL_ACCOUNTS", "CLOUD_ACCOUNTS", + "FILE_AND_DIRECTORY_DISCOVERY", + "ACCOUNT_DISCOVERY_LOCAL_ACCOUNT", "PROXY", "EXTERNAL_PROXY", "MULTI_HOP_PROXY", @@ -11649,6 +11737,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -11656,10 +11745,14 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "SUPPLY_CHAIN_COMPROMISE", + "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", + "DATA_ENCRYPTED_FOR_IMPACT", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", "FIRMWARE_CORRUPTION", @@ -11674,12 +11767,23 @@ "EVENT_TRIGGERED_EXECUTION", "BOOT_OR_LOGON_AUTOSTART_EXECUTION", "KERNEL_MODULES_AND_EXTENSIONS", + "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", + "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", + "CREDENTIALS_IN_FILES", + "BASH_HISTORY", + "PRIVATE_KEYS", + "SUBVERT_TRUST_CONTROL", + "INSTALL_ROOT_CERTIFICATE", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", + "PLUGGABLE_AUTHENTICATION_MODULES", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "INDICATOR_BLOCKING", + "DISABLE_OR_MODIFY_LINUX_AUDIT_SYSTEM", "HIDE_ARTIFACTS", "HIDDEN_FILES_AND_DIRECTORIES", "HIDDEN_USERS", @@ -11687,35 +11791,54 @@ "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", "LATERAL_TOOL_TRANSFER", + "HIJACK_EXECUTION_FLOW", + "HIJACK_EXECUTION_FLOW_DYNAMIC_LINKER_HIJACKING", "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", + "OBTAIN_CAPABILITIES_VULNERABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", + "UPLOAD_MALWARE", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", - "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" + "REFLECTIVE_CODE_LOADING", + "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES", + "FINANCIAL_THEFT" ], "enumDescriptions": [ "Unspecified value.", "T1001", "T1001.002", + "T1003", + "T1003.007", + "T1003.008", + "T1005", "T1020", "T1027", "T1027.003", "T1027.004", "T1027.010", + "T1029", + "T1033", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", "T1053", + "T1053.003", "T1053.007", + "T1055", + "T1056", + "T1056.001", "T1057", "T1059", "T1059.004", @@ -11723,7 +11846,12 @@ "T1068", "T1069", "T1069.003", + "T1070", + "T1070.002", + "T1070.003", "T1070.004", + "T1070.006", + "T1070.008", "T1071", "T1071.004", "T1072", @@ -11731,6 +11859,8 @@ "T1078.001", "T1078.003", "T1078.004", + "T1083", + "T1087.001", "T1090", "T1090.002", "T1090.003", @@ -11743,6 +11873,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -11750,10 +11881,14 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", + "T1195", + "T1195.001", "T1204", "T1484", "T1485", + "T1486", "T1489", "T1490", "T1495", @@ -11768,12 +11903,23 @@ "T1546", "T1547", "T1547.006", + "T1547.009", "T1548", + "T1548.003", "T1552", + "T1552.001", + "T1552.003", + "T1552.004", + "T1553", + "T1553.004", "T1554", + "T1555", "T1556", + "T1556.003", "T1562", "T1562.001", + "T1562.006", + "T1562.012", "T1564", "T1564.001", "T1564.002", @@ -11781,18 +11927,27 @@ "T1567.002", "T1568", "T1570", + "T1574", + "T1574.006", "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", + "T1588.006", "T1595", "T1595.001", "T1608", + "T1608.001", "T1609", "T1610", "T1611", "T1613", - "T1649" + "T1620", + "T1649", + "T1657" ], "type": "string" }, @@ -11843,18 +11998,28 @@ "TECHNIQUE_UNSPECIFIED", "DATA_OBFUSCATION", "DATA_OBFUSCATION_STEGANOGRAPHY", + "OS_CREDENTIAL_DUMPING", + "OS_CREDENTIAL_DUMPING_PROC_FILESYSTEM", + "OS_CREDENTIAL_DUMPING_ETC_PASSWORD_AND_ETC_SHADOW", + "DATA_FROM_LOCAL_SYSTEM", "AUTOMATED_EXFILTRATION", "OBFUSCATED_FILES_OR_INFO", "STEGANOGRAPHY", "COMPILE_AFTER_DELIVERY", "COMMAND_OBFUSCATION", + "SCHEDULED_TRANSFER", + "SYSTEM_OWNER_USER_DISCOVERY", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", + "SCHEDULED_TASK_JOB_CRON", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", + "INPUT_CAPTURE", + "INPUT_CAPTURE_KEYLOGGING", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -11862,7 +12027,12 @@ "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL", + "INDICATOR_REMOVAL_CLEAR_LINUX_OR_MAC_SYSTEM_LOGS", + "INDICATOR_REMOVAL_CLEAR_COMMAND_HISTORY", "INDICATOR_REMOVAL_FILE_DELETION", + "INDICATOR_REMOVAL_TIMESTOMP", + "INDICATOR_REMOVAL_CLEAR_MAILBOX_DATA", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -11870,6 +12040,8 @@ "DEFAULT_ACCOUNTS", "LOCAL_ACCOUNTS", "CLOUD_ACCOUNTS", + "FILE_AND_DIRECTORY_DISCOVERY", + "ACCOUNT_DISCOVERY_LOCAL_ACCOUNT", "PROXY", "EXTERNAL_PROXY", "MULTI_HOP_PROXY", @@ -11882,6 +12054,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -11889,10 +12062,14 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "SUPPLY_CHAIN_COMPROMISE", + "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", + "DATA_ENCRYPTED_FOR_IMPACT", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", "FIRMWARE_CORRUPTION", @@ -11907,12 +12084,23 @@ "EVENT_TRIGGERED_EXECUTION", "BOOT_OR_LOGON_AUTOSTART_EXECUTION", "KERNEL_MODULES_AND_EXTENSIONS", + "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", + "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", + "CREDENTIALS_IN_FILES", + "BASH_HISTORY", + "PRIVATE_KEYS", + "SUBVERT_TRUST_CONTROL", + "INSTALL_ROOT_CERTIFICATE", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", + "PLUGGABLE_AUTHENTICATION_MODULES", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "INDICATOR_BLOCKING", + "DISABLE_OR_MODIFY_LINUX_AUDIT_SYSTEM", "HIDE_ARTIFACTS", "HIDDEN_FILES_AND_DIRECTORIES", "HIDDEN_USERS", @@ -11920,35 +12108,54 @@ "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", "LATERAL_TOOL_TRANSFER", + "HIJACK_EXECUTION_FLOW", + "HIJACK_EXECUTION_FLOW_DYNAMIC_LINKER_HIJACKING", "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", + "OBTAIN_CAPABILITIES_VULNERABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", + "UPLOAD_MALWARE", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", - "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" + "REFLECTIVE_CODE_LOADING", + "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES", + "FINANCIAL_THEFT" ], "enumDescriptions": [ "Unspecified value.", "T1001", "T1001.002", + "T1003", + "T1003.007", + "T1003.008", + "T1005", "T1020", "T1027", "T1027.003", "T1027.004", "T1027.010", + "T1029", + "T1033", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", "T1053", + "T1053.003", "T1053.007", + "T1055", + "T1056", + "T1056.001", "T1057", "T1059", "T1059.004", @@ -11956,7 +12163,12 @@ "T1068", "T1069", "T1069.003", + "T1070", + "T1070.002", + "T1070.003", "T1070.004", + "T1070.006", + "T1070.008", "T1071", "T1071.004", "T1072", @@ -11964,6 +12176,8 @@ "T1078.001", "T1078.003", "T1078.004", + "T1083", + "T1087.001", "T1090", "T1090.002", "T1090.003", @@ -11976,6 +12190,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -11983,10 +12198,14 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", + "T1195", + "T1195.001", "T1204", "T1484", "T1485", + "T1486", "T1489", "T1490", "T1495", @@ -12001,12 +12220,23 @@ "T1546", "T1547", "T1547.006", + "T1547.009", "T1548", + "T1548.003", "T1552", + "T1552.001", + "T1552.003", + "T1552.004", + "T1553", + "T1553.004", "T1554", + "T1555", "T1556", + "T1556.003", "T1562", "T1562.001", + "T1562.006", + "T1562.012", "T1564", "T1564.001", "T1564.002", @@ -12014,18 +12244,27 @@ "T1567.002", "T1568", "T1570", + "T1574", + "T1574.006", "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", + "T1588.006", "T1595", "T1595.001", "T1608", + "T1608.001", "T1609", "T1610", "T1611", "T1613", - "T1649" + "T1620", + "T1649", + "T1657" ], "type": "string" }, @@ -13941,18 +14180,28 @@ "TECHNIQUE_UNSPECIFIED", "DATA_OBFUSCATION", "DATA_OBFUSCATION_STEGANOGRAPHY", + "OS_CREDENTIAL_DUMPING", + "OS_CREDENTIAL_DUMPING_PROC_FILESYSTEM", + "OS_CREDENTIAL_DUMPING_ETC_PASSWORD_AND_ETC_SHADOW", + "DATA_FROM_LOCAL_SYSTEM", "AUTOMATED_EXFILTRATION", "OBFUSCATED_FILES_OR_INFO", "STEGANOGRAPHY", "COMPILE_AFTER_DELIVERY", "COMMAND_OBFUSCATION", + "SCHEDULED_TRANSFER", + "SYSTEM_OWNER_USER_DISCOVERY", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", + "SCHEDULED_TASK_JOB_CRON", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", + "INPUT_CAPTURE", + "INPUT_CAPTURE_KEYLOGGING", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -13960,7 +14209,12 @@ "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL", + "INDICATOR_REMOVAL_CLEAR_LINUX_OR_MAC_SYSTEM_LOGS", + "INDICATOR_REMOVAL_CLEAR_COMMAND_HISTORY", "INDICATOR_REMOVAL_FILE_DELETION", + "INDICATOR_REMOVAL_TIMESTOMP", + "INDICATOR_REMOVAL_CLEAR_MAILBOX_DATA", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -13968,6 +14222,8 @@ "DEFAULT_ACCOUNTS", "LOCAL_ACCOUNTS", "CLOUD_ACCOUNTS", + "FILE_AND_DIRECTORY_DISCOVERY", + "ACCOUNT_DISCOVERY_LOCAL_ACCOUNT", "PROXY", "EXTERNAL_PROXY", "MULTI_HOP_PROXY", @@ -13980,6 +14236,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -13987,10 +14244,14 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "SUPPLY_CHAIN_COMPROMISE", + "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", + "DATA_ENCRYPTED_FOR_IMPACT", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", "FIRMWARE_CORRUPTION", @@ -14005,12 +14266,23 @@ "EVENT_TRIGGERED_EXECUTION", "BOOT_OR_LOGON_AUTOSTART_EXECUTION", "KERNEL_MODULES_AND_EXTENSIONS", + "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", + "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", + "CREDENTIALS_IN_FILES", + "BASH_HISTORY", + "PRIVATE_KEYS", + "SUBVERT_TRUST_CONTROL", + "INSTALL_ROOT_CERTIFICATE", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", + "PLUGGABLE_AUTHENTICATION_MODULES", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "INDICATOR_BLOCKING", + "DISABLE_OR_MODIFY_LINUX_AUDIT_SYSTEM", "HIDE_ARTIFACTS", "HIDDEN_FILES_AND_DIRECTORIES", "HIDDEN_USERS", @@ -14018,35 +14290,54 @@ "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", "LATERAL_TOOL_TRANSFER", + "HIJACK_EXECUTION_FLOW", + "HIJACK_EXECUTION_FLOW_DYNAMIC_LINKER_HIJACKING", "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", + "OBTAIN_CAPABILITIES_VULNERABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", + "UPLOAD_MALWARE", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", - "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" + "REFLECTIVE_CODE_LOADING", + "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES", + "FINANCIAL_THEFT" ], "enumDescriptions": [ "Unspecified value.", "T1001", "T1001.002", + "T1003", + "T1003.007", + "T1003.008", + "T1005", "T1020", "T1027", "T1027.003", "T1027.004", "T1027.010", + "T1029", + "T1033", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", "T1053", + "T1053.003", "T1053.007", + "T1055", + "T1056", + "T1056.001", "T1057", "T1059", "T1059.004", @@ -14054,7 +14345,12 @@ "T1068", "T1069", "T1069.003", + "T1070", + "T1070.002", + "T1070.003", "T1070.004", + "T1070.006", + "T1070.008", "T1071", "T1071.004", "T1072", @@ -14062,6 +14358,8 @@ "T1078.001", "T1078.003", "T1078.004", + "T1083", + "T1087.001", "T1090", "T1090.002", "T1090.003", @@ -14074,6 +14372,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -14081,10 +14380,14 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", + "T1195", + "T1195.001", "T1204", "T1484", "T1485", + "T1486", "T1489", "T1490", "T1495", @@ -14099,12 +14402,23 @@ "T1546", "T1547", "T1547.006", + "T1547.009", "T1548", + "T1548.003", "T1552", + "T1552.001", + "T1552.003", + "T1552.004", + "T1553", + "T1553.004", "T1554", + "T1555", "T1556", + "T1556.003", "T1562", "T1562.001", + "T1562.006", + "T1562.012", "T1564", "T1564.001", "T1564.002", @@ -14112,18 +14426,27 @@ "T1567.002", "T1568", "T1570", + "T1574", + "T1574.006", "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", + "T1588.006", "T1595", "T1595.001", "T1608", + "T1608.001", "T1609", "T1610", "T1611", "T1613", - "T1649" + "T1620", + "T1649", + "T1657" ], "type": "string" }, @@ -14174,18 +14497,28 @@ "TECHNIQUE_UNSPECIFIED", "DATA_OBFUSCATION", "DATA_OBFUSCATION_STEGANOGRAPHY", + "OS_CREDENTIAL_DUMPING", + "OS_CREDENTIAL_DUMPING_PROC_FILESYSTEM", + "OS_CREDENTIAL_DUMPING_ETC_PASSWORD_AND_ETC_SHADOW", + "DATA_FROM_LOCAL_SYSTEM", "AUTOMATED_EXFILTRATION", "OBFUSCATED_FILES_OR_INFO", "STEGANOGRAPHY", "COMPILE_AFTER_DELIVERY", "COMMAND_OBFUSCATION", + "SCHEDULED_TRANSFER", + "SYSTEM_OWNER_USER_DISCOVERY", "MASQUERADING", "MATCH_LEGITIMATE_NAME_OR_LOCATION", "BOOT_OR_LOGON_INITIALIZATION_SCRIPTS", "STARTUP_ITEMS", "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", + "SCHEDULED_TASK_JOB_CRON", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", + "INPUT_CAPTURE", + "INPUT_CAPTURE_KEYLOGGING", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -14193,7 +14526,12 @@ "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL", + "INDICATOR_REMOVAL_CLEAR_LINUX_OR_MAC_SYSTEM_LOGS", + "INDICATOR_REMOVAL_CLEAR_COMMAND_HISTORY", "INDICATOR_REMOVAL_FILE_DELETION", + "INDICATOR_REMOVAL_TIMESTOMP", + "INDICATOR_REMOVAL_CLEAR_MAILBOX_DATA", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -14201,6 +14539,8 @@ "DEFAULT_ACCOUNTS", "LOCAL_ACCOUNTS", "CLOUD_ACCOUNTS", + "FILE_AND_DIRECTORY_DISCOVERY", + "ACCOUNT_DISCOVERY_LOCAL_ACCOUNT", "PROXY", "EXTERNAL_PROXY", "MULTI_HOP_PROXY", @@ -14213,6 +14553,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -14220,10 +14561,14 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", + "SUPPLY_CHAIN_COMPROMISE", + "COMPROMISE_SOFTWARE_DEPENDENCIES_AND_DEVELOPMENT_TOOLS", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", "DATA_DESTRUCTION", + "DATA_ENCRYPTED_FOR_IMPACT", "SERVICE_STOP", "INHIBIT_SYSTEM_RECOVERY", "FIRMWARE_CORRUPTION", @@ -14238,12 +14583,23 @@ "EVENT_TRIGGERED_EXECUTION", "BOOT_OR_LOGON_AUTOSTART_EXECUTION", "KERNEL_MODULES_AND_EXTENSIONS", + "SHORTCUT_MODIFICATION", "ABUSE_ELEVATION_CONTROL_MECHANISM", + "ABUSE_ELEVATION_CONTROL_MECHANISM_SUDO_AND_SUDO_CACHING", "UNSECURED_CREDENTIALS", + "CREDENTIALS_IN_FILES", + "BASH_HISTORY", + "PRIVATE_KEYS", + "SUBVERT_TRUST_CONTROL", + "INSTALL_ROOT_CERTIFICATE", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", + "PLUGGABLE_AUTHENTICATION_MODULES", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", + "INDICATOR_BLOCKING", + "DISABLE_OR_MODIFY_LINUX_AUDIT_SYSTEM", "HIDE_ARTIFACTS", "HIDDEN_FILES_AND_DIRECTORIES", "HIDDEN_USERS", @@ -14251,35 +14607,54 @@ "EXFILTRATION_TO_CLOUD_STORAGE", "DYNAMIC_RESOLUTION", "LATERAL_TOOL_TRANSFER", + "HIJACK_EXECUTION_FLOW", + "HIJACK_EXECUTION_FLOW_DYNAMIC_LINKER_HIJACKING", "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", + "OBTAIN_CAPABILITIES_VULNERABILITIES", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", + "UPLOAD_MALWARE", "CONTAINER_ADMINISTRATION_COMMAND", "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", - "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" + "REFLECTIVE_CODE_LOADING", + "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES", + "FINANCIAL_THEFT" ], "enumDescriptions": [ "Unspecified value.", "T1001", "T1001.002", + "T1003", + "T1003.007", + "T1003.008", + "T1005", "T1020", "T1027", "T1027.003", "T1027.004", "T1027.010", + "T1029", + "T1033", "T1036", "T1036.005", "T1037", "T1037.005", "T1046", "T1053", + "T1053.003", "T1053.007", + "T1055", + "T1056", + "T1056.001", "T1057", "T1059", "T1059.004", @@ -14287,7 +14662,12 @@ "T1068", "T1069", "T1069.003", + "T1070", + "T1070.002", + "T1070.003", "T1070.004", + "T1070.006", + "T1070.008", "T1071", "T1071.004", "T1072", @@ -14295,6 +14675,8 @@ "T1078.001", "T1078.003", "T1078.004", + "T1083", + "T1087.001", "T1090", "T1090.002", "T1090.003", @@ -14307,6 +14689,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -14314,10 +14697,14 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", + "T1195", + "T1195.001", "T1204", "T1484", "T1485", + "T1486", "T1489", "T1490", "T1495", @@ -14332,12 +14719,23 @@ "T1546", "T1547", "T1547.006", + "T1547.009", "T1548", + "T1548.003", "T1552", + "T1552.001", + "T1552.003", + "T1552.004", + "T1553", + "T1553.004", "T1554", + "T1555", "T1556", + "T1556.003", "T1562", "T1562.001", + "T1562.006", + "T1562.012", "T1564", "T1564.001", "T1564.002", @@ -14345,18 +14743,27 @@ "T1567.002", "T1568", "T1570", + "T1574", + "T1574.006", "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", + "T1588.006", "T1595", "T1595.001", "T1608", + "T1608.001", "T1609", "T1610", "T1611", "T1613", - "T1649" + "T1620", + "T1649", + "T1657" ], "type": "string" }, @@ -14717,10 +15124,12 @@ "id": "Position", "properties": { "columnNumber": { + "description": "The column number.", "format": "int32", "type": "integer" }, "lineNumber": { + "description": "The line number.", "format": "int32", "type": "integer" } diff --git a/discovery/securitycenter-v1beta1.json b/discovery/securitycenter-v1beta1.json index 5ea5cd9301..da78224f3e 100644 --- a/discovery/securitycenter-v1beta1.json +++ b/discovery/securitycenter-v1beta1.json @@ -913,7 +913,7 @@ } } }, - "revision": "20250411", + "revision": "20250509", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6293,6 +6293,7 @@ "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -6320,6 +6321,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -6327,6 +6329,7 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", @@ -6347,7 +6350,10 @@ "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "BASH_HISTORY", + "PRIVATE_KEYS", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", @@ -6361,7 +6367,10 @@ "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", @@ -6369,6 +6378,7 @@ "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", + "REFLECTIVE_CODE_LOADING", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" ], "enumDescriptions": [ @@ -6387,6 +6397,7 @@ "T1046", "T1053", "T1053.007", + "T1055", "T1057", "T1059", "T1059.004", @@ -6414,6 +6425,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -6421,6 +6433,7 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", "T1204", "T1484", @@ -6441,7 +6454,10 @@ "T1547.006", "T1548", "T1552", + "T1552.003", + "T1552.004", "T1554", + "T1555", "T1556", "T1562", "T1562.001", @@ -6455,7 +6471,10 @@ "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", "T1595", "T1595.001", "T1608", @@ -6463,6 +6482,7 @@ "T1610", "T1611", "T1613", + "T1620", "T1649" ], "type": "string" @@ -6526,6 +6546,7 @@ "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -6553,6 +6574,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -6560,6 +6582,7 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", @@ -6580,7 +6603,10 @@ "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "BASH_HISTORY", + "PRIVATE_KEYS", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", @@ -6594,7 +6620,10 @@ "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", @@ -6602,6 +6631,7 @@ "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", + "REFLECTIVE_CODE_LOADING", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" ], "enumDescriptions": [ @@ -6620,6 +6650,7 @@ "T1046", "T1053", "T1053.007", + "T1055", "T1057", "T1059", "T1059.004", @@ -6647,6 +6678,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -6654,6 +6686,7 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", "T1204", "T1484", @@ -6674,7 +6707,10 @@ "T1547.006", "T1548", "T1552", + "T1552.003", + "T1552.004", "T1554", + "T1555", "T1556", "T1562", "T1562.001", @@ -6688,7 +6724,10 @@ "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", "T1595", "T1595.001", "T1608", @@ -6696,6 +6735,7 @@ "T1610", "T1611", "T1613", + "T1620", "T1649" ], "type": "string" @@ -8343,6 +8383,7 @@ "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -8370,6 +8411,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -8377,6 +8419,7 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", @@ -8397,7 +8440,10 @@ "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "BASH_HISTORY", + "PRIVATE_KEYS", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", @@ -8411,7 +8457,10 @@ "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", @@ -8419,6 +8468,7 @@ "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", + "REFLECTIVE_CODE_LOADING", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" ], "enumDescriptions": [ @@ -8437,6 +8487,7 @@ "T1046", "T1053", "T1053.007", + "T1055", "T1057", "T1059", "T1059.004", @@ -8464,6 +8515,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -8471,6 +8523,7 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", "T1204", "T1484", @@ -8491,7 +8544,10 @@ "T1547.006", "T1548", "T1552", + "T1552.003", + "T1552.004", "T1554", + "T1555", "T1556", "T1562", "T1562.001", @@ -8505,7 +8561,10 @@ "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", "T1595", "T1595.001", "T1608", @@ -8513,6 +8572,7 @@ "T1610", "T1611", "T1613", + "T1620", "T1649" ], "type": "string" @@ -8576,6 +8636,7 @@ "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -8603,6 +8664,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -8610,6 +8672,7 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", @@ -8630,7 +8693,10 @@ "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "BASH_HISTORY", + "PRIVATE_KEYS", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", @@ -8644,7 +8710,10 @@ "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", @@ -8652,6 +8721,7 @@ "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", + "REFLECTIVE_CODE_LOADING", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" ], "enumDescriptions": [ @@ -8670,6 +8740,7 @@ "T1046", "T1053", "T1053.007", + "T1055", "T1057", "T1059", "T1059.004", @@ -8697,6 +8768,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -8704,6 +8776,7 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", "T1204", "T1484", @@ -8724,7 +8797,10 @@ "T1547.006", "T1548", "T1552", + "T1552.003", + "T1552.004", "T1554", + "T1555", "T1556", "T1562", "T1562.001", @@ -8738,7 +8814,10 @@ "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", "T1595", "T1595.001", "T1608", @@ -8746,6 +8825,7 @@ "T1610", "T1611", "T1613", + "T1620", "T1649" ], "type": "string" diff --git a/discovery/securitycenter-v1beta2.json b/discovery/securitycenter-v1beta2.json index 1919acb3e3..f19429def5 100644 --- a/discovery/securitycenter-v1beta2.json +++ b/discovery/securitycenter-v1beta2.json @@ -2003,7 +2003,7 @@ } } }, - "revision": "20250411", + "revision": "20250509", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -7286,6 +7286,7 @@ "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -7313,6 +7314,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -7320,6 +7322,7 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", @@ -7340,7 +7343,10 @@ "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "BASH_HISTORY", + "PRIVATE_KEYS", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", @@ -7354,7 +7360,10 @@ "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", @@ -7362,6 +7371,7 @@ "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", + "REFLECTIVE_CODE_LOADING", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" ], "enumDescriptions": [ @@ -7380,6 +7390,7 @@ "T1046", "T1053", "T1053.007", + "T1055", "T1057", "T1059", "T1059.004", @@ -7407,6 +7418,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -7414,6 +7426,7 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", "T1204", "T1484", @@ -7434,7 +7447,10 @@ "T1547.006", "T1548", "T1552", + "T1552.003", + "T1552.004", "T1554", + "T1555", "T1556", "T1562", "T1562.001", @@ -7448,7 +7464,10 @@ "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", "T1595", "T1595.001", "T1608", @@ -7456,6 +7475,7 @@ "T1610", "T1611", "T1613", + "T1620", "T1649" ], "type": "string" @@ -7519,6 +7539,7 @@ "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -7546,6 +7567,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -7553,6 +7575,7 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", @@ -7573,7 +7596,10 @@ "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "BASH_HISTORY", + "PRIVATE_KEYS", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", @@ -7587,7 +7613,10 @@ "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", @@ -7595,6 +7624,7 @@ "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", + "REFLECTIVE_CODE_LOADING", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" ], "enumDescriptions": [ @@ -7613,6 +7643,7 @@ "T1046", "T1053", "T1053.007", + "T1055", "T1057", "T1059", "T1059.004", @@ -7640,6 +7671,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -7647,6 +7679,7 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", "T1204", "T1484", @@ -7667,7 +7700,10 @@ "T1547.006", "T1548", "T1552", + "T1552.003", + "T1552.004", "T1554", + "T1555", "T1556", "T1562", "T1562.001", @@ -7681,7 +7717,10 @@ "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", "T1595", "T1595.001", "T1608", @@ -7689,6 +7728,7 @@ "T1610", "T1611", "T1613", + "T1620", "T1649" ], "type": "string" @@ -9087,6 +9127,7 @@ "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -9114,6 +9155,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -9121,6 +9163,7 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", @@ -9141,7 +9184,10 @@ "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "BASH_HISTORY", + "PRIVATE_KEYS", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", @@ -9155,7 +9201,10 @@ "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", @@ -9163,6 +9212,7 @@ "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", + "REFLECTIVE_CODE_LOADING", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" ], "enumDescriptions": [ @@ -9181,6 +9231,7 @@ "T1046", "T1053", "T1053.007", + "T1055", "T1057", "T1059", "T1059.004", @@ -9208,6 +9259,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -9215,6 +9267,7 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", "T1204", "T1484", @@ -9235,7 +9288,10 @@ "T1547.006", "T1548", "T1552", + "T1552.003", + "T1552.004", "T1554", + "T1555", "T1556", "T1562", "T1562.001", @@ -9249,7 +9305,10 @@ "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", "T1595", "T1595.001", "T1608", @@ -9257,6 +9316,7 @@ "T1610", "T1611", "T1613", + "T1620", "T1649" ], "type": "string" @@ -9320,6 +9380,7 @@ "NETWORK_SERVICE_DISCOVERY", "SCHEDULED_TASK_JOB", "CONTAINER_ORCHESTRATION_JOB", + "PROCESS_INJECTION", "PROCESS_DISCOVERY", "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", @@ -9347,6 +9408,7 @@ "INGRESS_TOOL_TRANSFER", "NATIVE_API", "BRUTE_FORCE", + "AUTOMATED_COLLECTION", "SHARED_MODULES", "DATA_ENCODING", "STANDARD_ENCODING", @@ -9354,6 +9416,7 @@ "TOKEN_IMPERSONATION_OR_THEFT", "CREATE_ACCOUNT", "LOCAL_ACCOUNT", + "DEOBFUSCATE_DECODE_FILES_OR_INFO", "EXPLOIT_PUBLIC_FACING_APPLICATION", "USER_EXECUTION", "DOMAIN_POLICY_MODIFICATION", @@ -9374,7 +9437,10 @@ "KERNEL_MODULES_AND_EXTENSIONS", "ABUSE_ELEVATION_CONTROL_MECHANISM", "UNSECURED_CREDENTIALS", + "BASH_HISTORY", + "PRIVATE_KEYS", "COMPROMISE_HOST_SOFTWARE_BINARY", + "CREDENTIALS_FROM_PASSWORD_STORES", "MODIFY_AUTHENTICATION_PROCESS", "IMPAIR_DEFENSES", "DISABLE_OR_MODIFY_TOOLS", @@ -9388,7 +9454,10 @@ "MODIFY_CLOUD_COMPUTE_INFRASTRUCTURE", "CREATE_SNAPSHOT", "CLOUD_INFRASTRUCTURE_DISCOVERY", + "DEVELOP_CAPABILITIES", + "DEVELOP_CAPABILITIES_MALWARE", "OBTAIN_CAPABILITIES", + "OBTAIN_CAPABILITIES_MALWARE", "ACTIVE_SCANNING", "SCANNING_IP_BLOCKS", "STAGE_CAPABILITIES", @@ -9396,6 +9465,7 @@ "DEPLOY_CONTAINER", "ESCAPE_TO_HOST", "CONTAINER_AND_RESOURCE_DISCOVERY", + "REFLECTIVE_CODE_LOADING", "STEAL_OR_FORGE_AUTHENTICATION_CERTIFICATES" ], "enumDescriptions": [ @@ -9414,6 +9484,7 @@ "T1046", "T1053", "T1053.007", + "T1055", "T1057", "T1059", "T1059.004", @@ -9441,6 +9512,7 @@ "T1105", "T1106", "T1110", + "T1119", "T1129", "T1132", "T1132.001", @@ -9448,6 +9520,7 @@ "T1134.001", "T1136", "T1136.001", + "T1140", "T1190", "T1204", "T1484", @@ -9468,7 +9541,10 @@ "T1547.006", "T1548", "T1552", + "T1552.003", + "T1552.004", "T1554", + "T1555", "T1556", "T1562", "T1562.001", @@ -9482,7 +9558,10 @@ "T1578", "T1578.001", "T1580", + "T1587", + "T1587.001", "T1588", + "T1588.001", "T1595", "T1595.001", "T1608", @@ -9490,6 +9569,7 @@ "T1610", "T1611", "T1613", + "T1620", "T1649" ], "type": "string" diff --git a/discovery/serviceconsumermanagement-v1.json b/discovery/serviceconsumermanagement-v1.json index cb970fff45..bdf237a28b 100644 --- a/discovery/serviceconsumermanagement-v1.json +++ b/discovery/serviceconsumermanagement-v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20250313", + "revision": "20250511", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -642,7 +642,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.", "type": "object" } }, diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index 2cb98bba81..30e4a3ee3c 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -715,7 +715,7 @@ } } }, - "revision": "20250313", + "revision": "20250511", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -785,7 +785,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.", "type": "object" } }, diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index 8ceea753f8..5fdd7e6f76 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -830,7 +830,7 @@ } } }, - "revision": "20250414", + "revision": "20250502", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -911,7 +911,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.", "type": "object" } }, diff --git a/discovery/servicenetworking-v1.json b/discovery/servicenetworking-v1.json index 676197f75e..21ae4d9f9a 100644 --- a/discovery/servicenetworking-v1.json +++ b/discovery/servicenetworking-v1.json @@ -1029,7 +1029,7 @@ } } }, - "revision": "20250316", + "revision": "20250518", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1300,7 +1300,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.", "type": "object" } }, @@ -1483,6 +1483,101 @@ }, "type": "object" }, + "BatchingConfigProto": { + "description": "`BatchingConfigProto` defines the batching configuration for an API method.", + "id": "BatchingConfigProto", + "properties": { + "batchDescriptor": { + "$ref": "BatchingDescriptorProto", + "description": "The request and response fields used in batching." + }, + "thresholds": { + "$ref": "BatchingSettingsProto", + "description": "The thresholds which trigger a batched request to be sent." + } + }, + "type": "object" + }, + "BatchingDescriptorProto": { + "description": "`BatchingDescriptorProto` specifies the fields of the request message to be used for batching, and, optionally, the fields of the response message to be used for demultiplexing.", + "id": "BatchingDescriptorProto", + "properties": { + "batchedField": { + "description": "The repeated field in the request message to be aggregated by batching.", + "type": "string" + }, + "discriminatorFields": { + "description": "A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in `request_discriminator_fields` is equal between the two requests.", + "items": { + "type": "string" + }, + "type": "array" + }, + "subresponseField": { + "description": "Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together.", + "type": "string" + } + }, + "type": "object" + }, + "BatchingSettingsProto": { + "description": "`BatchingSettingsProto` specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero.", + "id": "BatchingSettingsProto", + "properties": { + "delayThreshold": { + "description": "The duration after which a batch should be sent, starting from the addition of the first message to that batch.", + "format": "google-duration", + "type": "string" + }, + "elementCountLimit": { + "description": "The maximum number of elements collected in a batch that could be accepted by server.", + "format": "int32", + "type": "integer" + }, + "elementCountThreshold": { + "description": "The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.", + "format": "int32", + "type": "integer" + }, + "flowControlByteLimit": { + "description": "The maximum size of data allowed by flow control.", + "format": "int32", + "type": "integer" + }, + "flowControlElementLimit": { + "description": "The maximum number of elements allowed by flow control.", + "format": "int32", + "type": "integer" + }, + "flowControlLimitExceededBehavior": { + "description": "The behavior to take when the flow control limit is exceeded.", + "enum": [ + "UNSET_BEHAVIOR", + "THROW_EXCEPTION", + "BLOCK", + "IGNORE" + ], + "enumDescriptions": [ + "Default behavior, system-defined.", + "Stop operation, raise error.", + "Pause operation until limit clears.", + "Continue operation, disregard limit." + ], + "type": "string" + }, + "requestByteLimit": { + "description": "The maximum size of the request that could be accepted by server.", + "format": "int32", + "type": "integer" + }, + "requestByteThreshold": { + "description": "The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Billing": { "description": "Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: \"1\" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count", "id": "Billing", @@ -2848,6 +2943,10 @@ }, "type": "array" }, + "batching": { + "$ref": "BatchingConfigProto", + "description": "Batching configuration for an API method in client libraries. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.BatchCreateExample batching: element_count_threshold: 1000 request_byte_threshold: 100000000 delay_threshold_millis: 10" + }, "longRunning": { "$ref": "LongRunning", "description": "Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 minutes" diff --git a/discovery/servicenetworking-v1beta.json b/discovery/servicenetworking-v1beta.json index 8d7c2e8a08..3a67263722 100644 --- a/discovery/servicenetworking-v1beta.json +++ b/discovery/servicenetworking-v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20250312", + "revision": "20250518", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -467,7 +467,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.", "type": "object" } }, @@ -650,6 +650,101 @@ }, "type": "object" }, + "BatchingConfigProto": { + "description": "`BatchingConfigProto` defines the batching configuration for an API method.", + "id": "BatchingConfigProto", + "properties": { + "batchDescriptor": { + "$ref": "BatchingDescriptorProto", + "description": "The request and response fields used in batching." + }, + "thresholds": { + "$ref": "BatchingSettingsProto", + "description": "The thresholds which trigger a batched request to be sent." + } + }, + "type": "object" + }, + "BatchingDescriptorProto": { + "description": "`BatchingDescriptorProto` specifies the fields of the request message to be used for batching, and, optionally, the fields of the response message to be used for demultiplexing.", + "id": "BatchingDescriptorProto", + "properties": { + "batchedField": { + "description": "The repeated field in the request message to be aggregated by batching.", + "type": "string" + }, + "discriminatorFields": { + "description": "A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in `request_discriminator_fields` is equal between the two requests.", + "items": { + "type": "string" + }, + "type": "array" + }, + "subresponseField": { + "description": "Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together.", + "type": "string" + } + }, + "type": "object" + }, + "BatchingSettingsProto": { + "description": "`BatchingSettingsProto` specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero.", + "id": "BatchingSettingsProto", + "properties": { + "delayThreshold": { + "description": "The duration after which a batch should be sent, starting from the addition of the first message to that batch.", + "format": "google-duration", + "type": "string" + }, + "elementCountLimit": { + "description": "The maximum number of elements collected in a batch that could be accepted by server.", + "format": "int32", + "type": "integer" + }, + "elementCountThreshold": { + "description": "The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.", + "format": "int32", + "type": "integer" + }, + "flowControlByteLimit": { + "description": "The maximum size of data allowed by flow control.", + "format": "int32", + "type": "integer" + }, + "flowControlElementLimit": { + "description": "The maximum number of elements allowed by flow control.", + "format": "int32", + "type": "integer" + }, + "flowControlLimitExceededBehavior": { + "description": "The behavior to take when the flow control limit is exceeded.", + "enum": [ + "UNSET_BEHAVIOR", + "THROW_EXCEPTION", + "BLOCK", + "IGNORE" + ], + "enumDescriptions": [ + "Default behavior, system-defined.", + "Stop operation, raise error.", + "Pause operation until limit clears.", + "Continue operation, disregard limit." + ], + "type": "string" + }, + "requestByteLimit": { + "description": "The maximum size of the request that could be accepted by server.", + "format": "int32", + "type": "integer" + }, + "requestByteThreshold": { + "description": "The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Billing": { "description": "Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: \"1\" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count", "id": "Billing", @@ -1868,6 +1963,10 @@ }, "type": "array" }, + "batching": { + "$ref": "BatchingConfigProto", + "description": "Batching configuration for an API method in client libraries. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.BatchCreateExample batching: element_count_threshold: 1000 request_byte_threshold: 100000000 delay_threshold_millis: 10" + }, "longRunning": { "$ref": "LongRunning", "description": "Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 minutes" diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index aec2d5293a..a1c711a5cd 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20250313", + "revision": "20250511", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -634,7 +634,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.", "type": "object" } }, diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index 9270b20919..c2223c8724 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -964,7 +964,7 @@ } } }, - "revision": "20250417", + "revision": "20250511", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1172,7 +1172,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.", + "description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`.", "type": "object" } }, diff --git a/discovery/sheets-v4.json b/discovery/sheets-v4.json index dbfc7765f5..27f3e55a58 100644 --- a/discovery/sheets-v4.json +++ b/discovery/sheets-v4.json @@ -875,7 +875,7 @@ } } }, - "revision": "20250415", + "revision": "20250513", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -1110,6 +1110,18 @@ }, "type": "object" }, + "AddTableResponse": { + "description": "The result of adding a table.", + "id": "AddTableResponse", + "properties": { + "table": { + "$ref": "Table", + "description": "Output only. The table that was added.", + "readOnly": true + } + }, + "type": "object" + }, "AppendCellsRequest": { "description": "Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary.", "id": "AppendCellsRequest", @@ -1227,10 +1239,15 @@ "id": "BandedRange", "properties": { "bandedRangeId": { - "description": "The ID of the banded range.", + "description": "The ID of the banded range. If unset, refer to banded_range_reference.", "format": "int32", "type": "integer" }, + "bandedRangeReference": { + "description": "Output only. The reference of the banded range, used to identify the ID that is not supported by the banded_range_id.", + "readOnly": true, + "type": "string" + }, "columnProperties": { "$ref": "BandingProperties", "description": "Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of row_properties or column_properties must be specified." @@ -6409,6 +6426,10 @@ "$ref": "AddSlicerResponse", "description": "A reply from adding a slicer." }, + "addTable": { + "$ref": "AddTableResponse", + "description": "A reply from adding a table." + }, "cancelDataSourceRefresh": { "$ref": "CancelDataSourceRefreshResponse", "description": "A reply from cancelling data source object refreshes." diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 007136cd83..e6a249334f 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -234,7 +234,7 @@ ] }, "UpdateBackup": { - "description": "This API updates the following: 1- retention period and description of backup in case of final backups only. 2- gcbdr_soft_delete_status of backup in case of GCBDR managed backups only.", + "description": "Updates the retention period and description of the backup. You can use this API to update final backups only.", "flatPath": "v1/projects/{projectsId}/backups/{backupsId}", "httpMethod": "PATCH", "id": "sql.Backups.UpdateBackup", @@ -250,7 +250,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields that you can update. 1- You can update only the description and retention period for a final backup. 2- You can update only the gcbdr_soft_delete_status for GCBDR managed backup.", + "description": "The list of fields that you can update. You can update only the description and retention period of the final backup.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2594,7 +2594,7 @@ } } }, - "revision": "20250427", + "revision": "20250508", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -3820,7 +3820,7 @@ "type": "boolean" }, "flags": { - "description": "Optional. List of connection pool configuration flags", + "description": "Optional. List of connection pool configuration flags.", "items": { "$ref": "ConnectionPoolFlags" }, @@ -5364,7 +5364,7 @@ "type": "integer" }, "queryStringLength": { - "description": "Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.", + "description": "Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.", "format": "int32", "type": "integer" }, @@ -6529,7 +6529,7 @@ "id": "PscAutoConnectionConfig", "properties": { "consumerNetwork": { - "description": "The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project.", + "description": "Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project.", "type": "string" }, "consumerNetworkStatus": { @@ -6537,7 +6537,7 @@ "type": "string" }, "consumerProject": { - "description": "This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network.", + "description": "Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network.", "type": "string" }, "ipAddress": { @@ -6562,6 +6562,10 @@ }, "type": "array" }, + "networkAttachmentUri": { + "description": "Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID", + "type": "string" + }, "pscAutoConnections": { "description": "Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.", "items": { diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 71c89da3b9..7d90e29cbc 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -396,7 +396,7 @@ ] }, "updateBackup": { - "description": "This API updates the following: 1- retention period and description of backup in case of final backups only. 2- gcbdr_soft_delete_status of backup in case of GCBDR managed backups only.", + "description": "Updates the retention period and the description of the backup. You can use this API to update final backups only.", "flatPath": "sql/v1beta4/projects/{projectsId}/backups/{backupsId}", "httpMethod": "PATCH", "id": "sql.backups.updateBackup", @@ -412,7 +412,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields that you can update. 1- You can update only the description and retention period for a final backup. 2- You can update only the gcbdr_soft_delete_status for GCBDR managed backup.", + "description": "The list of fields that you can update. You can update only the description and retention period of the final backup.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2594,7 +2594,7 @@ } } }, - "revision": "20250427", + "revision": "20250508", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -3820,7 +3820,7 @@ "type": "boolean" }, "flags": { - "description": "Optional. List of connection pool configuration flags", + "description": "Optional. List of connection pool configuration flags.", "items": { "$ref": "ConnectionPoolFlags" }, @@ -5365,7 +5365,7 @@ "type": "integer" }, "queryStringLength": { - "description": "Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.", + "description": "Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.", "format": "int32", "type": "integer" }, @@ -6527,7 +6527,7 @@ "id": "PscAutoConnectionConfig", "properties": { "consumerNetwork": { - "description": "The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project.", + "description": "Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project.", "type": "string" }, "consumerNetworkStatus": { @@ -6535,7 +6535,7 @@ "type": "string" }, "consumerProject": { - "description": "This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network.", + "description": "Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network.", "type": "string" }, "ipAddress": { @@ -6560,6 +6560,10 @@ }, "type": "array" }, + "networkAttachmentUri": { + "description": "Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID", + "type": "string" + }, "pscAutoConnections": { "description": "Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.", "items": { @@ -6924,7 +6928,7 @@ "type": "string" }, "replicationLagMaxSeconds": { - "description": "Optional. Configuration value for recreation of replica after certain replication lag", + "description": "Optional. Configuration value for recreation of replica after certain replication lag.", "format": "int32", "type": "integer" }, diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index 3d82bb4d97..eac81179d6 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -236,9 +236,14 @@ "description": "Regional Endpoint", "endpointUrl": "https://storage.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.europe-north2.rep.googleapis.com/", + "location": "europe-north2" } ], - "etag": "\"38353737343034333936303735343633323432\"", + "etag": "\"38313932303531353034313530333239303931\"", "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" @@ -4524,7 +4529,7 @@ } } }, - "revision": "20250424", + "revision": "20250509", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { diff --git a/discovery/storagetransfer-v1.json b/discovery/storagetransfer-v1.json index 711d0ac60d..ba34753fed 100644 --- a/discovery/storagetransfer-v1.json +++ b/discovery/storagetransfer-v1.json @@ -632,7 +632,7 @@ } } }, - "revision": "20250426", + "revision": "20250510", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -764,6 +764,10 @@ "description": "Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { \"sas_token\" : \"SAS_TOKEN\" } GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If `credentials_secret` is specified, do not specify azure_credentials. Format: `projects/{project_number}/secrets/{secret_name}`", "type": "string" }, + "federatedIdentityConfig": { + "$ref": "FederatedIdentityConfig", + "description": "Optional. Federated identity config of a user registered Azure application. If `federated_identity_config` is specified, do not specify azure_credentials or credentials_secret." + }, "path": { "description": "Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.", "type": "string" @@ -932,6 +936,21 @@ }, "type": "object" }, + "FederatedIdentityConfig": { + "description": "Identities of a user registered Azure application that enables identity federation to trust tokens issued by the user's Google service account. For more information about Azure application and identity federation, see [Register an application with the Microsoft identity platform] (https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) Azure RBAC roles then need be assigned to the Azure application to authorize access to the user's Azure data source. For more information about Azure RBAC roles for blobs, see [Manage Access Rights with RBAC] (https://learn.microsoft.com/en-us/rest/api/storageservices/authorize-with-azure-active-directory#manage-access-rights-with-rbac)", + "id": "FederatedIdentityConfig", + "properties": { + "clientId": { + "description": "Required. Client (application) ID of the application with federated credentials.", + "type": "string" + }, + "tenantId": { + "description": "Required. Tenant (directory) ID of the application with federated credentials.", + "type": "string" + } + }, + "type": "object" + }, "GcsData": { "description": "In a GcsData resource, an object's name is the Cloud Storage object's name and its \"last modification time\" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated.", "id": "GcsData", @@ -982,7 +1001,7 @@ "id": "HttpData", "properties": { "listUrl": { - "description": "Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported.", + "description": "Required. The URL that points to the file that stores the object list entries. This file must allow public access. The URL is either an HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a Cloud Storage path (e.g. `gs://my-bucket/urllist.tsv`).", "type": "string" } }, @@ -1277,7 +1296,7 @@ "type": "object" }, "ObjectConditions": { - "description": "Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage. The \"last modification time\" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects, the `LastModified` field of S3 objects, and the `Last-Modified` header of Azure blobs. Transfers with a PosixFilesystem source or destination don't support `ObjectConditions`.", + "description": "Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage. The \"last modification time\" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects, the `LastModified` field of S3 objects, and the `Last-Modified` header of Azure blobs. For S3 objects, the `LastModified` value is the time the object begins uploading. If the object meets your \"last modification time\" criteria, but has not finished uploading, the object is not transferred. See [Transfer from Amazon S3 to Cloud Storage](https://cloud.google.com/storage-transfer/docs/create-transfers/agentless/s3#transfer_options) for more information. Transfers with a PosixFilesystem source or destination don't support `ObjectConditions`.", "id": "ObjectConditions", "properties": { "excludePrefixes": { @@ -1724,6 +1743,10 @@ "$ref": "Schedule", "description": "Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule." }, + "serviceAccount": { + "description": "Optional. The service account to be used to access resources in the consumer project in the transfer job. We accept `email` or `uniqueId` for the service account. Service account format is projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID} See https://cloud.google.com/iam/docs/reference/credentials/rest/v1/projects.serviceAccounts/generateAccessToken#path-parameters for details. Caller requires the following IAM permission on the specified service account: `iam.serviceAccounts.actAs`. project-PROJECT_NUMBER@storage-transfer-service.iam.gserviceaccount.com requires the following IAM permission on the specified service account: `iam.serviceAccounts.getAccessToken`", + "type": "string" + }, "status": { "description": "Status of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.", "enum": [ diff --git a/discovery/sts-v1.json b/discovery/sts-v1.json index 571a516394..a2eeca2680 100644 --- a/discovery/sts-v1.json +++ b/discovery/sts-v1.json @@ -17,6 +17,11 @@ "endpointUrl": "https://sts.asia-east1.rep.googleapis.com/", "location": "asia-east1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.asia-northeast1.rep.googleapis.com/", @@ -333,7 +338,7 @@ } } }, - "revision": "20250331", + "revision": "20250507", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/discovery/sts-v1beta.json b/discovery/sts-v1beta.json index 2cccbb4425..4dd4263da6 100644 --- a/discovery/sts-v1beta.json +++ b/discovery/sts-v1beta.json @@ -17,6 +17,11 @@ "endpointUrl": "https://sts.asia-east1.rep.googleapis.com/", "location": "asia-east1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://sts.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://sts.asia-northeast1.rep.googleapis.com/", @@ -333,7 +338,7 @@ } } }, - "revision": "20250331", + "revision": "20250507", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/discovery/tasks-v1.json b/discovery/tasks-v1.json index 25cff4aa78..ac76005f08 100644 --- a/discovery/tasks-v1.json +++ b/discovery/tasks-v1.json @@ -475,7 +475,7 @@ "type": "string" }, "parent": { - "description": "Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned tasks can not be set as parent task (have subtasks) or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty.", + "description": "Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned and repeating tasks cannot be set as parent tasks (have subtasks), or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty.", "location": "query", "type": "string" }, @@ -576,7 +576,7 @@ } } }, - "revision": "20250415", + "revision": "20250518", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "AssignmentInfo": { diff --git a/discovery/texttospeech-v1.json b/discovery/texttospeech-v1.json index 06d7de39c6..9c13ee24b8 100644 --- a/discovery/texttospeech-v1.json +++ b/discovery/texttospeech-v1.json @@ -318,7 +318,7 @@ } } }, - "revision": "20250415", + "revision": "20250424", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -403,12 +403,16 @@ "enum": [ "PHONETIC_ENCODING_UNSPECIFIED", "PHONETIC_ENCODING_IPA", - "PHONETIC_ENCODING_X_SAMPA" + "PHONETIC_ENCODING_X_SAMPA", + "PHONETIC_ENCODING_JAPANESE_YOMIGANA", + "PHONETIC_ENCODING_PINYIN" ], "enumDescriptions": [ "Not specified.", "IPA, such as apple -> ˈæpəl. https://en.wikipedia.org/wiki/International_Phonetic_Alphabet", - "X-SAMPA, such as apple -> \"{p@l\". https://en.wikipedia.org/wiki/X-SAMPA" + "X-SAMPA, such as apple -> \"{p@l\". https://en.wikipedia.org/wiki/X-SAMPA", + "For reading-to-pron conversion to work well, the `pronunciation` field should only contain Kanji, Hiragana, and Katakana. The pronunciation can also contain pitch accents. The start of a pitch phrase is specified with `^` and the down-pitch position is specified with `!`, for example: phrase:端 pronunciation:^はし phrase:箸 pronunciation:^は!し phrase:橋 pronunciation:^はし! We currently only support the Tokyo dialect, which allows at most one down-pitch per phrase (i.e. at most one `!` between `^`).", + "Used to specify pronunciations for Mandarin words. See https://en.wikipedia.org/wiki/Pinyin. For example: 朝阳, the pronunciation is \"chao2 yang2\". The number represents the tone, and there is a space between syllables. Neutral tones are represented by 5, for example 孩子 \"hai2 zi5\"." ], "type": "string" }, @@ -608,6 +612,10 @@ "$ref": "CustomPronunciations", "description": "Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag." }, + "markup": { + "description": "Markup for HD voices specifically. This field may not be used with any other voices.", + "type": "string" + }, "multiSpeakerMarkup": { "$ref": "MultiSpeakerMarkup", "description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis." diff --git a/discovery/texttospeech-v1beta1.json b/discovery/texttospeech-v1beta1.json index 7cca734776..5bb19cb45e 100644 --- a/discovery/texttospeech-v1beta1.json +++ b/discovery/texttospeech-v1beta1.json @@ -261,7 +261,7 @@ } } }, - "revision": "20250415", + "revision": "20250424", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AdvancedVoiceOptions": { @@ -342,12 +342,16 @@ "enum": [ "PHONETIC_ENCODING_UNSPECIFIED", "PHONETIC_ENCODING_IPA", - "PHONETIC_ENCODING_X_SAMPA" + "PHONETIC_ENCODING_X_SAMPA", + "PHONETIC_ENCODING_JAPANESE_YOMIGANA", + "PHONETIC_ENCODING_PINYIN" ], "enumDescriptions": [ "Not specified.", "IPA, such as apple -> ˈæpəl. https://en.wikipedia.org/wiki/International_Phonetic_Alphabet", - "X-SAMPA, such as apple -> \"{p@l\". https://en.wikipedia.org/wiki/X-SAMPA" + "X-SAMPA, such as apple -> \"{p@l\". https://en.wikipedia.org/wiki/X-SAMPA", + "For reading-to-pron conversion to work well, the `pronunciation` field should only contain Kanji, Hiragana, and Katakana. The pronunciation can also contain pitch accents. The start of a pitch phrase is specified with `^` and the down-pitch position is specified with `!`, for example: phrase:端 pronunciation:^はし phrase:箸 pronunciation:^は!し phrase:橋 pronunciation:^はし! We currently only support the Tokyo dialect, which allows at most one down-pitch per phrase (i.e. at most one `!` between `^`).", + "Used to specify pronunciations for Mandarin words. See https://en.wikipedia.org/wiki/Pinyin. For example: 朝阳, the pronunciation is \"chao2 yang2\". The number represents the tone, and there is a space between syllables. Neutral tones are represented by 5, for example 孩子 \"hai2 zi5\"." ], "type": "string" }, @@ -541,6 +545,10 @@ "$ref": "CustomPronunciations", "description": "Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag." }, + "markup": { + "description": "Markup for HD voices specifically. This field may not be used with any other voices.", + "type": "string" + }, "multiSpeakerMarkup": { "$ref": "MultiSpeakerMarkup", "description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis." diff --git a/discovery/walletobjects-v1.json b/discovery/walletobjects-v1.json index b7e59580b7..f2e1a6fc8f 100644 --- a/discovery/walletobjects-v1.json +++ b/discovery/walletobjects-v1.json @@ -2711,7 +2711,7 @@ } } }, - "revision": "20250312", + "revision": "20250506", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -3610,7 +3610,7 @@ "id": "DiscoverableProgramMerchantSignupInfo", "properties": { "signupSharedDatas": { - "description": " User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.", + "description": "User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program.", "items": { "enum": [ "SHARED_DATA_TYPE_UNSPECIFIED", @@ -4369,14 +4369,14 @@ true ], "enumDescriptions": [ - "", + "Default value.", "Object is active and displayed to with other active objects.", "Legacy alias for `ACTIVE`. Deprecated.", - "", + "Object has completed it's lifecycle.", "Legacy alias for `COMPLETED`. Deprecated.", "Object is no longer valid (`validTimeInterval` passed).", "Legacy alias for `EXPIRED`. Deprecated.", - "", + "Object is no longer valid", "Legacy alias for `INACTIVE`. Deprecated." ], "type": "string" @@ -5175,14 +5175,14 @@ true ], "enumDescriptions": [ - "", + "Default value.", "Object is active and displayed to with other active objects.", "Legacy alias for `ACTIVE`. Deprecated.", - "", + "Object has completed it's lifecycle.", "Legacy alias for `COMPLETED`. Deprecated.", "Object is no longer valid (`validTimeInterval` passed).", "Legacy alias for `EXPIRED`. Deprecated.", - "", + "Object is no longer valid", "Legacy alias for `INACTIVE`. Deprecated." ], "type": "string" @@ -5573,14 +5573,14 @@ true ], "enumDescriptions": [ - "", + "Default value.", "Object is active and displayed to with other active objects.", "Legacy alias for `ACTIVE`. Deprecated.", - "", + "Object has completed it's lifecycle.", "Legacy alias for `COMPLETED`. Deprecated.", "Object is no longer valid (`validTimeInterval` passed).", "Legacy alias for `EXPIRED`. Deprecated.", - "", + "Object is no longer valid", "Legacy alias for `INACTIVE`. Deprecated." ], "type": "string" @@ -6112,14 +6112,14 @@ true ], "enumDescriptions": [ - "", + "Default value.", "Object is active and displayed to with other active objects.", "Legacy alias for `ACTIVE`. Deprecated.", - "", + "Object has completed it's lifecycle.", "Legacy alias for `COMPLETED`. Deprecated.", "Object is no longer valid (`validTimeInterval` passed).", "Legacy alias for `EXPIRED`. Deprecated.", - "", + "Object is no longer valid", "Legacy alias for `INACTIVE`. Deprecated." ], "type": "string" @@ -7005,14 +7005,14 @@ true ], "enumDescriptions": [ - "", + "Default value.", "Object is active and displayed to with other active objects.", "Legacy alias for `ACTIVE`. Deprecated.", - "", + "Object has completed it's lifecycle.", "Legacy alias for `COMPLETED`. Deprecated.", "Object is no longer valid (`validTimeInterval` passed).", "Legacy alias for `EXPIRED`. Deprecated.", - "", + "Object is no longer valid", "Legacy alias for `INACTIVE`. Deprecated." ], "type": "string" @@ -8019,14 +8019,14 @@ true ], "enumDescriptions": [ - "", + "Default value.", "Object is active and displayed to with other active objects.", "Legacy alias for `ACTIVE`. Deprecated.", - "", + "Object has completed it's lifecycle.", "Legacy alias for `COMPLETED`. Deprecated.", "Object is no longer valid (`validTimeInterval` passed).", "Legacy alias for `EXPIRED`. Deprecated.", - "", + "Object is no longer valid", "Legacy alias for `INACTIVE`. Deprecated." ], "type": "string" @@ -9551,14 +9551,14 @@ true ], "enumDescriptions": [ - "", + "Default value.", "Object is active and displayed to with other active objects.", "Legacy alias for `ACTIVE`. Deprecated.", - "", + "Object has completed it's lifecycle.", "Legacy alias for `COMPLETED`. Deprecated.", "Object is no longer valid (`validTimeInterval` passed).", "Legacy alias for `EXPIRED`. Deprecated.", - "", + "Object is no longer valid", "Legacy alias for `INACTIVE`. Deprecated." ], "type": "string" diff --git a/release-please-config.json b/release-please-config.json index 81ed6fd13b..cdfeac30c1 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -311,6 +311,8 @@ "src/apis/areainsights": {}, "src/apis/managedkafka": {}, "src/apis/observability": {}, - "src/apis/storagebatchoperations": {} + "src/apis/storagebatchoperations": {}, + "src/apis/apihub": {}, + "src/apis/firebaseapphosting": {} } } \ No newline at end of file diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 3b388557b8..9e9ea3e1d3 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -1071,7 +1071,7 @@ export namespace admin_directory_v1 { */ export interface Schema$DirectoryChromeosdevicesCommandResult { /** - * The payload for the command result. The following commands respond with a payload: * `DEVICE_START_CRD_SESSION`: Payload is a stringified JSON object in the form: { "url": url \}. The URL provides a link to the Chrome Remote Desktop session. + * The payload for the command result. The following commands respond with a payload: * `DEVICE_START_CRD_SESSION`: Payload is a stringified JSON object in the form: { "url": url \}. The URL provides a link to the Chrome Remote Desktop session. * `FETCH_CRD_AVAILABILITY_INFO`: Payload is a stringified JSON object in the form: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string \}. The "remoteSupportAvailability" field is set to "AVAILABLE" if `shared` CRD session to the device is available. The "remoteAccessAvailability" field is set to "AVAILABLE" if `private` CRD session to the device is available. */ commandResultPayload?: string | null; /** diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index 35dc12bfbf..f083b455c6 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -1046,7 +1046,7 @@ export namespace admin_reports_v1 { */ pageToken?: string; /** - * The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. + * The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `chat`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. */ parameters?: string; } @@ -1287,7 +1287,7 @@ export namespace admin_reports_v1 { */ date?: string; /** - * The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<\>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal to'. - `<\>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `\>` - 'greater than'. It is URL-encoded (%3E). - `\>=` - 'greater than or equal to'. It is URL-encoded (%3E=). + * The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `chat`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<\>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal to'. - `<\>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `\>` - 'greater than'. It is URL-encoded (%3E). - `\>=` - 'greater than or equal to'. It is URL-encoded (%3E=). */ filters?: string; /** @@ -1307,7 +1307,7 @@ export namespace admin_reports_v1 { */ pageToken?: string; /** - * The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers Usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. + * The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers Usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `chat`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. */ parameters?: string; /** diff --git a/src/apis/adsense/v2.ts b/src/apis/adsense/v2.ts index 98b94f1e58..92f8a4029f 100644 --- a/src/apis/adsense/v2.ts +++ b/src/apis/adsense/v2.ts @@ -597,7 +597,7 @@ export namespace adsense_v2 { */ export interface Schema$PolicyTopic { /** - * Required. Deprecated. Policy topics no longer have a "must-fix" classification. + * Required. Deprecated. Always set to false. */ mustFix?: boolean | null; /** diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 30a9053f4f..e897ceafb9 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -550,6 +550,10 @@ export namespace aiplatform_v1 { * Required. The SecretManager secret version resource name storing API key. e.g. projects/{project\}/secrets/{secret\}/versions/{version\} */ apiKeySecretVersion?: string | null; + /** + * The API key string. Either this or `api_key_secret_version` must be set. + */ + apiKeyString?: string | null; } /** * Instance of a general artifact. @@ -710,6 +714,100 @@ export namespace aiplatform_v1 { */ facts?: Schema$GoogleCloudAiplatformV1Fact[]; } + /** + * Auth configuration to run the extension. + */ + export interface Schema$GoogleCloudAiplatformV1AuthConfig { + /** + * Config for API key auth. + */ + apiKeyConfig?: Schema$GoogleCloudAiplatformV1AuthConfigApiKeyConfig; + /** + * Type of auth scheme. + */ + authType?: string | null; + /** + * Config for Google Service Account auth. + */ + googleServiceAccountConfig?: Schema$GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig; + /** + * Config for HTTP Basic auth. + */ + httpBasicAuthConfig?: Schema$GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig; + /** + * Config for user oauth. + */ + oauthConfig?: Schema$GoogleCloudAiplatformV1AuthConfigOauthConfig; + /** + * Config for user OIDC auth. + */ + oidcConfig?: Schema$GoogleCloudAiplatformV1AuthConfigOidcConfig; + } + /** + * Config for authentication with API key. + */ + export interface Schema$GoogleCloudAiplatformV1AuthConfigApiKeyConfig { + /** + * Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project\}/secrets/{secrete\}/versions/{version\}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - 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; + /** + * Optional. The API key to be used in the request directly. + */ + apiKeyString?: string | null; + /** + * Optional. The location of the API key. + */ + httpElementLocation?: string | null; + /** + * Optional. 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$GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig { + /** + * 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$GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig { + /** + * 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; + } + /** + * Config for user oauth. + */ + export interface Schema$GoogleCloudAiplatformV1AuthConfigOauthConfig { + /** + * 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$GoogleCloudAiplatformV1AuthConfigOidcConfig { + /** + * 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. */ @@ -1353,6 +1451,10 @@ export namespace aiplatform_v1 { * Optional. Immutable. The user-generated meaningful display name of the cached content. */ displayName?: string | null; + /** + * Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key. + */ + encryptionSpec?: Schema$GoogleCloudAiplatformV1EncryptionSpec; /** * Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. */ @@ -1488,6 +1590,23 @@ export namespace aiplatform_v1 { */ safetyRatings?: Schema$GoogleCloudAiplatformV1SafetyRating[]; } + /** + * Describes the machine learning model version checkpoint. + */ + export interface Schema$GoogleCloudAiplatformV1Checkpoint { + /** + * The ID of the checkpoint. + */ + checkpointId?: string | null; + /** + * The epoch of the checkpoint. + */ + epoch?: string | null; + /** + * The step of the checkpoint. + */ + step?: string | null; + } /** * This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request. */ @@ -2946,6 +3065,10 @@ export namespace aiplatform_v1 { * A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. */ automaticResources?: Schema$GoogleCloudAiplatformV1AutomaticResources; + /** + * The checkpoint id of the model. + */ + checkpointId?: string | null; /** * Output only. Timestamp when the DeployedModel was created. */ @@ -3019,6 +3142,10 @@ export namespace aiplatform_v1 { * Points to a DeployedModel. */ export interface Schema$GoogleCloudAiplatformV1DeployedModelRef { + /** + * Immutable. The ID of the Checkpoint deployed in the DeployedModel. + */ + checkpointId?: string | null; /** * Immutable. An ID of a DeployedModel in the above Endpoint. */ @@ -4546,6 +4673,56 @@ export namespace aiplatform_v1 { */ timeSeriesDataPoints?: Schema$GoogleCloudAiplatformV1TimeSeriesDataPoint[]; } + /** + * Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. + */ + export interface Schema$GoogleCloudAiplatformV1ExternalApi { + /** + * The authentication config to access the API. Deprecated. Please use auth_config instead. + */ + apiAuth?: Schema$GoogleCloudAiplatformV1ApiAuth; + /** + * The API spec that the external API implements. + */ + apiSpec?: string | null; + /** + * The authentication config to access the API. + */ + authConfig?: Schema$GoogleCloudAiplatformV1AuthConfig; + /** + * Parameters for the elastic search API. + */ + elasticSearchParams?: Schema$GoogleCloudAiplatformV1ExternalApiElasticSearchParams; + /** + * The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + */ + endpoint?: string | null; + /** + * Parameters for the simple search API. + */ + simpleSearchParams?: Schema$GoogleCloudAiplatformV1ExternalApiSimpleSearchParams; + } + /** + * The search parameters to use for the ELASTIC_SEARCH spec. + */ + export interface Schema$GoogleCloudAiplatformV1ExternalApiElasticSearchParams { + /** + * The ElasticSearch index to use. + */ + index?: string | null; + /** + * Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + */ + numHits?: number | null; + /** + * The ElasticSearch search template to use. + */ + searchTemplate?: string | null; + } + /** + * The search parameters to use for SIMPLE_SEARCH spec. + */ + export interface Schema$GoogleCloudAiplatformV1ExternalApiSimpleSearchParams {} /** * The fact used in grounding. */ @@ -6058,6 +6235,10 @@ export namespace aiplatform_v1 { * Config for thinking features. */ export interface Schema$GoogleCloudAiplatformV1GenerationConfigThinkingConfig { + /** + * Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. + */ + includeThoughts?: boolean | null; /** * Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true. */ @@ -6550,6 +6731,10 @@ export namespace aiplatform_v1 { * Specifies the transformation config for RagFiles. */ ragFileTransformationConfig?: Schema$GoogleCloudAiplatformV1RagFileTransformationConfig; + /** + * Rebuilds the ANN index to optimize for recall on the imported data. Only applicable for RagCorpora running on RagManagedDb with `retrieval_strategy` set to `ANN`. The rebuild will be performed using the existing ANN config set on the RagCorpus. To change the ANN config, please use the UpdateRagCorpus API. Default is false, i.e., index is not rebuilt. + */ + rebuildAnnIndex?: boolean | null; /** * SharePoint sources. */ @@ -8170,6 +8355,10 @@ export namespace aiplatform_v1 { * Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. */ baseModelSource?: Schema$GoogleCloudAiplatformV1ModelBaseModelSource; + /** + * Optional. Output only. The checkpoints of the model. + */ + checkpoints?: Schema$GoogleCloudAiplatformV1Checkpoint[]; /** * Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. */ @@ -9683,7 +9872,7 @@ export namespace aiplatform_v1 { values?: string[] | null; } /** - * A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours. + * A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade. */ export interface Schema$GoogleCloudAiplatformV1NotebookRuntime { /** @@ -9894,7 +10083,7 @@ export namespace aiplatform_v1 { notebookRuntimeTemplate?: string | null; } /** - * Notebook Software Config. + * Notebook Software Config. This is passed to the backend when user makes software configurations in UI. */ export interface Schema$GoogleCloudAiplatformV1NotebookSoftwareConfig { /** @@ -10151,6 +10340,10 @@ export namespace aiplatform_v1 { * Optional. Text part (can be code). */ text?: string | null; + /** + * Output only. Indicates if the part is thought from the model. + */ + thought?: boolean | null; /** * Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */ @@ -11836,6 +12029,10 @@ export namespace aiplatform_v1 { * The Layout Parser to use for RagFiles. */ layoutParser?: Schema$GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser; + /** + * The LLM Parser to use for RagFiles. + */ + llmParser?: Schema$GoogleCloudAiplatformV1RagFileParsingConfigLlmParser; } /** * Document AI Layout Parser config. @@ -11850,6 +12047,23 @@ export namespace aiplatform_v1 { */ processorName?: string | null; } + /** + * Specifies the LLM parsing for RagFiles. + */ + export interface Schema$GoogleCloudAiplatformV1RagFileParsingConfigLlmParser { + /** + * The prompt to use for parsing. If not specified, a default prompt will be used. + */ + customParsingPrompt?: string | null; + /** + * The maximum number of requests the job is allowed to make to the LLM model per minute. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If unspecified, a default value of 5000 QPM would be used. + */ + maxParsingRequestsPerMin?: number | null; + /** + * The name of a LLM model used for parsing. Format: * `projects/{project_id\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + modelName?: string | null; + } /** * Specifies the transformation config for RagFiles. */ @@ -11974,7 +12188,33 @@ export namespace aiplatform_v1 { /** * The config for the default RAG-managed Vector DB. */ - export interface Schema$GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb {} + export interface Schema$GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDb { + /** + * Performs an ANN search on RagCorpus. Use this if you have a lot of files (\> 10K) in your RagCorpus and want to reduce the search latency. + */ + ann?: Schema$GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN; + /** + * Performs a KNN search on RagCorpus. Default choice if not specified. + */ + knn?: Schema$GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN; + } + /** + * Config for ANN search. RagManagedDb uses a tree-based structure to partition data and facilitate faster searches. As a tradeoff, it requires longer indexing time and manual triggering of index rebuild via the ImportRagFiles and UpdateRagCorpus API. + */ + export interface Schema$GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbANN { + /** + * Number of leaf nodes in the tree-based structure. Each leaf node contains groups of closely related vectors along with their corresponding centroid. Recommended value is 10 * sqrt(num of RagFiles in your RagCorpus). Default value is 500. + */ + leafCount?: number | null; + /** + * The depth of the tree-based structure. Only depth values of 2 and 3 are supported. Recommended value is 2 if you have if you have O(10K) files in the RagCorpus and set this to 3 if more than that. Default value is 2. + */ + treeDepth?: number | null; + } + /** + * Config for KNN search. + */ + export interface Schema$GoogleCloudAiplatformV1RagVectorDbConfigRagManagedDbKNN {} /** * The config for the Vertex Vector Search. */ @@ -12228,7 +12468,7 @@ export namespace aiplatform_v1 { */ etag?: string | null; /** - * Identifier. The resource name of the ReasoningEngine. + * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string | null; /** @@ -12479,6 +12719,10 @@ export namespace aiplatform_v1 { * Optional. Deprecated. This option is no longer supported. */ disableAttribution?: boolean | null; + /** + * Use data source powered by external API for grounding. + */ + externalApi?: Schema$GoogleCloudAiplatformV1ExternalApi; /** * Set to use data source powered by Vertex AI Search. */ @@ -12986,6 +13230,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-object). More fields may be added in the future as needed. */ export interface Schema$GoogleCloudAiplatformV1Schema { + /** + * Optional. Can either be a boolean or an object; controls the presence of additional properties. + */ + additionalProperties?: any | null; /** * Optional. The value should be validated against any (one or more) of the subschemas in the list. */ @@ -12994,6 +13242,10 @@ export namespace aiplatform_v1 { * Optional. Default value of the data. */ default?: any | null; + /** + * Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + */ + defs?: {[key: string]: Schema$GoogleCloudAiplatformV1Schema} | null; /** * Optional. The description of the data. */ @@ -13062,6 +13314,10 @@ export namespace aiplatform_v1 { * Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. */ propertyOrdering?: string[] | null; + /** + * Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + */ + ref?: string | null; /** * Optional. Required properties of Type.OBJECT. */ @@ -17124,7 +17380,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1SupervisedTuningDataStats { /** - * Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself. + * Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. */ droppedExampleReasons?: string[] | null; /** @@ -17176,6 +17432,10 @@ export namespace aiplatform_v1 { * Tuning Spec for Supervised Tuning for first party models. */ export interface Schema$GoogleCloudAiplatformV1SupervisedTuningSpec { + /** + * Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. + */ + exportLastCheckpointOnly?: boolean | null; /** * Optional. Hyperparameters for SFT. */ @@ -18305,6 +18565,10 @@ export namespace aiplatform_v1 { * The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. */ export interface Schema$GoogleCloudAiplatformV1TunedModel { + /** + * Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints. + */ + checkpoints?: Schema$GoogleCloudAiplatformV1TunedModelCheckpoint[]; /** * Output only. A resource name of an Endpoint. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}`. */ @@ -18314,6 +18578,27 @@ export namespace aiplatform_v1 { */ model?: string | null; } + /** + * TunedModelCheckpoint for the Tuned Model of a Tuning Job. + */ + export interface Schema$GoogleCloudAiplatformV1TunedModelCheckpoint { + /** + * The ID of the checkpoint. + */ + checkpointId?: string | null; + /** + * The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}`. + */ + endpoint?: string | null; + /** + * The epoch of the checkpoint. + */ + epoch?: string | null; + /** + * The step of the checkpoint. + */ + step?: string | null; + } /** * TunedModel Reference for legacy model migration. */ @@ -18774,10 +19059,22 @@ export namespace aiplatform_v1 { * Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` */ datastore?: string | null; + /** + * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + */ + dataStoreSpecs?: Schema$GoogleCloudAiplatformV1VertexAISearchDataStoreSpec[]; /** * Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ engine?: string | null; + /** + * Optional. Filter strings to be passed to the search API. + */ + filter?: string | null; + /** + * Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + */ + maxResults?: number | null; } /** * Config for the Vertex AI Search. @@ -18788,6 +19085,19 @@ export namespace aiplatform_v1 { */ servingConfig?: string | null; } + /** + * Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + */ + export interface Schema$GoogleCloudAiplatformV1VertexAISearchDataStoreSpec { + /** + * Full resource name of DataStore, such as Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` + */ + dataStore?: string | null; + /** + * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; + } /** * Retrieve from Vertex RAG Store for grounding. */ @@ -72290,7 +72600,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Reasoningengines$Patch extends StandardParameters { /** - * Identifier. The resource name of the ReasoningEngine. + * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string; /** diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index 1878aa58e1..a1e9f28350 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -559,6 +559,10 @@ export namespace aiplatform_v1beta1 { * Required. The SecretManager secret version resource name storing API key. e.g. projects/{project\}/secrets/{secret\}/versions/{version\} */ apiKeySecretVersion?: string | null; + /** + * The API key string. Either this or `api_key_secret_version` must be set. + */ + apiKeyString?: string | null; } /** * Response message for SessionService.AppendEvent. @@ -1601,6 +1605,10 @@ export namespace aiplatform_v1beta1 { * Optional. Immutable. The user-generated meaningful display name of the cached content. */ displayName?: string | null; + /** + * Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key. + */ + encryptionSpec?: Schema$GoogleCloudAiplatformV1beta1EncryptionSpec; /** * Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. */ @@ -1736,6 +1744,23 @@ export namespace aiplatform_v1beta1 { */ safetyRatings?: Schema$GoogleCloudAiplatformV1beta1SafetyRating[]; } + /** + * Describes the machine learning model version checkpoint. + */ + export interface Schema$GoogleCloudAiplatformV1beta1Checkpoint { + /** + * The ID of the checkpoint. + */ + checkpointId?: string | null; + /** + * The epoch of the checkpoint. + */ + epoch?: string | null; + /** + * The step of the checkpoint. + */ + step?: string | null; + } /** * Request message for ModelGardenService.CheckPublisherModelEula. */ @@ -3364,6 +3389,10 @@ export namespace aiplatform_v1beta1 { * A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. */ automaticResources?: Schema$GoogleCloudAiplatformV1beta1AutomaticResources; + /** + * The checkpoint id of the model. + */ + checkpointId?: string | null; /** * Output only. Timestamp when the DeployedModel was created. */ @@ -3441,6 +3470,10 @@ export namespace aiplatform_v1beta1 { * Points to a DeployedModel. */ export interface Schema$GoogleCloudAiplatformV1beta1DeployedModelRef { + /** + * Immutable. The ID of the Checkpoint deployed in the DeployedModel. + */ + checkpointId?: string | null; /** * Immutable. An ID of a DeployedModel in the above Endpoint. */ @@ -4532,9 +4565,6 @@ export namespace aiplatform_v1beta1 { * Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. */ export interface Schema$GoogleCloudAiplatformV1beta1ExactMatchSpec {} - /** - * A single example to upload or read from the Example Store. - */ export interface Schema$GoogleCloudAiplatformV1beta1Example { /** * Output only. Timestamp when this Example was created. @@ -5439,6 +5469,56 @@ export namespace aiplatform_v1beta1 { */ serviceDirectory?: string | null; } + /** + * Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExternalApi { + /** + * The authentication config to access the API. Deprecated. Please use auth_config instead. + */ + apiAuth?: Schema$GoogleCloudAiplatformV1beta1ApiAuth; + /** + * The API spec that the external API implements. + */ + apiSpec?: string | null; + /** + * The authentication config to access the API. + */ + authConfig?: Schema$GoogleCloudAiplatformV1beta1AuthConfig; + /** + * Parameters for the elastic search API. + */ + elasticSearchParams?: Schema$GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams; + /** + * The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + */ + endpoint?: string | null; + /** + * Parameters for the simple search API. + */ + simpleSearchParams?: Schema$GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams; + } + /** + * The search parameters to use for the ELASTIC_SEARCH spec. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams { + /** + * The ElasticSearch index to use. + */ + index?: string | null; + /** + * Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + */ + numHits?: number | null; + /** + * The ElasticSearch search template to use. + */ + searchTemplate?: string | null; + } + /** + * The search parameters to use for SIMPLE_SEARCH spec. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams {} /** * The fact used in grounding. */ @@ -5865,7 +5945,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1FeatureSelectionConfigFeatureConfig { /** - * Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. + * Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. Must be in range [0, 1). */ driftThreshold?: number | null; /** @@ -7412,6 +7492,10 @@ export namespace aiplatform_v1beta1 { * Config for thinking features. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig { + /** + * Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. + */ + includeThoughts?: boolean | null; /** * Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true. */ @@ -7925,6 +8009,10 @@ export namespace aiplatform_v1beta1 { * Specifies the transformation config for RagFiles. */ ragFileTransformationConfig?: Schema$GoogleCloudAiplatformV1beta1RagFileTransformationConfig; + /** + * Rebuilds the ANN index to optimize for recall on the imported data. Only applicable for RagCorpora running on RagManagedDb with `retrieval_strategy` set to `ANN`. The rebuild will be performed using the existing ANN config set on the RagCorpus. To change the ANN config, please use the UpdateRagCorpus API. Default is false, i.e., index is not rebuilt. + */ + rebuildAnnIndex?: boolean | null; /** * SharePoint sources. */ @@ -9679,6 +9767,10 @@ export namespace aiplatform_v1beta1 { * Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models. */ baseModelSource?: Schema$GoogleCloudAiplatformV1beta1ModelBaseModelSource; + /** + * Optional. Output only. The checkpoints of the model. + */ + checkpoints?: Schema$GoogleCloudAiplatformV1beta1Checkpoint[]; /** * Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. */ @@ -10256,6 +10348,10 @@ export namespace aiplatform_v1beta1 { * The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8. */ displayName?: string | null; + /** + * Customer-managed encryption key spec for a ModelMonitor. If set, this ModelMonitor and all sub-resources of this ModelMonitor will be secured by this key. + */ + encryptionSpec?: Schema$GoogleCloudAiplatformV1beta1EncryptionSpec; /** * Optional model explanation spec. It is used for feature attribution monitoring. */ @@ -11794,7 +11890,7 @@ export namespace aiplatform_v1beta1 { values?: string[] | null; } /** - * A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours. + * A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade. */ export interface Schema$GoogleCloudAiplatformV1beta1NotebookRuntime { /** @@ -12005,7 +12101,7 @@ export namespace aiplatform_v1beta1 { notebookRuntimeTemplate?: string | null; } /** - * Notebook Software Config. + * Notebook Software Config. This is passed to the backend when user makes software configurations in UI. */ export interface Schema$GoogleCloudAiplatformV1beta1NotebookSoftwareConfig { /** @@ -14056,6 +14152,10 @@ export namespace aiplatform_v1beta1 { * Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. */ displayName?: string | null; + /** + * Optional. Immutable. The CMEK key name used to encrypt at-rest data related to this Corpus. Only applicable to RagManagedDb option for Vector DB. This field can only be set at corpus creation time, and cannot be updated or deleted. + */ + encryptionSpec?: Schema$GoogleCloudAiplatformV1beta1EncryptionSpec; /** * Output only. The resource name of the RagCorpus. */ @@ -14306,7 +14406,7 @@ export namespace aiplatform_v1beta1 { processorName?: string | null; } /** - * Specifies the advanced parsing for RagFiles. + * Specifies the LLM parsing for RagFiles. */ export interface Schema$GoogleCloudAiplatformV1beta1RagFileParsingConfigLlmParser { /** @@ -14509,7 +14609,33 @@ export namespace aiplatform_v1beta1 { /** * The config for the default RAG-managed Vector DB. */ - export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb {} + export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb { + /** + * Performs an ANN search on RagCorpus. Use this if you have a lot of files (\> 10K) in your RagCorpus and want to reduce the search latency. + */ + ann?: Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN; + /** + * Performs a KNN search on RagCorpus. Default choice if not specified. + */ + knn?: Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN; + } + /** + * Config for ANN search. RagManagedDb uses a tree-based structure to partition data and facilitate faster searches. As a tradeoff, it requires longer indexing time and manual triggering of index rebuild via the ImportRagFiles and UpdateRagCorpus API. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN { + /** + * Number of leaf nodes in the tree-based structure. Each leaf node contains groups of closely related vectors along with their corresponding centroid. Recommended value is 10 * sqrt(num of RagFiles in your RagCorpus). Default value is 500. + */ + leafCount?: number | null; + /** + * The depth of the tree-based structure. Only depth values of 2 and 3 are supported. Recommended value is 2 if you have if you have O(10K) files in the RagCorpus and set this to 3 if more than that. Default value is 2. + */ + treeDepth?: number | null; + } + /** + * Config for KNN search. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN {} /** * The config for the Vertex Feature Store. */ @@ -14789,7 +14915,7 @@ export namespace aiplatform_v1beta1 { */ etag?: string | null; /** - * Identifier. The resource name of the ReasoningEngine. + * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string | null; /** @@ -15121,6 +15247,10 @@ export namespace aiplatform_v1beta1 { * Optional. Deprecated. This option is no longer supported. */ disableAttribution?: boolean | null; + /** + * Use data source powered by external API for grounding. + */ + externalApi?: Schema$GoogleCloudAiplatformV1beta1ExternalApi; /** * Set to use data source powered by Vertex AI Search. */ @@ -15744,6 +15874,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-object). More fields may be added in the future as needed. */ export interface Schema$GoogleCloudAiplatformV1beta1Schema { + /** + * Optional. Can either be a boolean or an object; controls the presence of additional properties. + */ + additionalProperties?: any | null; /** * Optional. The value should be validated against any (one or more) of the subschemas in the list. */ @@ -15752,6 +15886,10 @@ export namespace aiplatform_v1beta1 { * Optional. Default value of the data. */ default?: any | null; + /** + * Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + */ + defs?: {[key: string]: Schema$GoogleCloudAiplatformV1beta1Schema} | null; /** * Optional. The description of the data. */ @@ -15822,6 +15960,10 @@ export namespace aiplatform_v1beta1 { * Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. */ propertyOrdering?: string[] | null; + /** + * Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + */ + ref?: string | null; /** * Optional. Required properties of Type.OBJECT. */ @@ -20252,7 +20394,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1SupervisedTuningDataStats { /** - * Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself. + * Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. */ droppedExampleReasons?: string[] | null; /** @@ -20304,6 +20446,10 @@ export namespace aiplatform_v1beta1 { * Tuning Spec for Supervised Tuning for first party models. */ export interface Schema$GoogleCloudAiplatformV1beta1SupervisedTuningSpec { + /** + * Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. + */ + exportLastCheckpointOnly?: boolean | null; /** * Optional. Hyperparameters for SFT. */ @@ -21481,6 +21627,10 @@ export namespace aiplatform_v1beta1 { * The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. */ export interface Schema$GoogleCloudAiplatformV1beta1TunedModel { + /** + * Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints. + */ + checkpoints?: Schema$GoogleCloudAiplatformV1beta1TunedModelCheckpoint[]; /** * Output only. A resource name of an Endpoint. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}`. */ @@ -21490,6 +21640,27 @@ export namespace aiplatform_v1beta1 { */ model?: string | null; } + /** + * TunedModelCheckpoint for the Tuned Model of a Tuning Job. + */ + export interface Schema$GoogleCloudAiplatformV1beta1TunedModelCheckpoint { + /** + * The ID of the checkpoint. + */ + checkpointId?: string | null; + /** + * The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}`. + */ + endpoint?: string | null; + /** + * The epoch of the checkpoint. + */ + epoch?: string | null; + /** + * The step of the checkpoint. + */ + step?: string | null; + } /** * TunedModel Reference for legacy model migration. */ @@ -22023,10 +22194,22 @@ export namespace aiplatform_v1beta1 { * Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` */ datastore?: string | null; + /** + * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + */ + dataStoreSpecs?: Schema$GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec[]; /** * Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ engine?: string | null; + /** + * Optional. Filter strings to be passed to the search API. + */ + filter?: string | null; + /** + * Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + */ + maxResults?: number | null; } /** * Config for the Vertex AI Search. @@ -22037,6 +22220,19 @@ export namespace aiplatform_v1beta1 { */ servingConfig?: string | null; } + /** + * Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + */ + export interface Schema$GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec { + /** + * Full resource name of DataStore, such as Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` + */ + dataStore?: string | null; + /** + * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; + } /** * Retrieve from Vertex RAG Store for grounding. */ @@ -85674,6 +85870,7 @@ export namespace aiplatform_v1beta1 { export class Resource$Projects$Locations$Reasoningengines { context: APIRequestContext; operations: Resource$Projects$Locations$Reasoningengines$Operations; + sandboxEnvironments: Resource$Projects$Locations$Reasoningengines$Sandboxenvironments; sessions: Resource$Projects$Locations$Reasoningengines$Sessions; constructor(context: APIRequestContext) { this.context = context; @@ -85681,6 +85878,10 @@ export namespace aiplatform_v1beta1 { new Resource$Projects$Locations$Reasoningengines$Operations( this.context ); + this.sandboxEnvironments = + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironments( + this.context + ); this.sessions = new Resource$Projects$Locations$Reasoningengines$Sessions( this.context ); @@ -86402,7 +86603,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Reasoningengines$Patch extends StandardParameters { /** - * Identifier. The resource name of the ReasoningEngine. + * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string; /** @@ -86967,6 +87168,545 @@ export namespace aiplatform_v1beta1 { timeout?: string; } + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironments { + context: APIRequestContext; + operations: Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Reasoningengines$Sandboxenvironments$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$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 + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Reasoningengines$Sandboxenvironments$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$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 + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Reasoningengines$Sandboxenvironments$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$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 + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$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 + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It 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$Reasoningengines$Sandboxenvironments$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$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 + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$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$Reasoningengines$Sandboxenvironments$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$Reasoningengines$Sessions { context: APIRequestContext; events: Resource$Projects$Locations$Reasoningengines$Sessions$Events; diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 5bad73fc6c..4ba90e346a 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -541,7 +541,7 @@ export namespace alloydb_v1 { */ export interface Schema$ContinuousBackupInfo { /** - * Output only. The earliest restorable time that can be restored to. Output only field. + * Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided. */ earliestRestorableTime?: string | null; /** @@ -553,7 +553,7 @@ export namespace alloydb_v1 { */ encryptionInfo?: Schema$EncryptionInfo; /** - * Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request. + * Output only. Days of the week on which a continuous backup is taken. */ schedule?: string[] | null; } @@ -842,6 +842,10 @@ export namespace alloydb_v1 { * An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. */ export interface Schema$Instance { + /** + * Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details. + */ + activationPolicy?: string | null; /** * Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 */ @@ -959,6 +963,10 @@ export namespace alloydb_v1 { * Metadata related to instance-level network configuration. */ export interface Schema$InstanceNetworkConfig { + /** + * Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + */ + allocatedIpRangeOverride?: string | null; /** * Optional. A list of external network authorized to access this instance. */ diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 7081a36378..58afb0b70e 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -614,7 +614,7 @@ export namespace alloydb_v1alpha { */ export interface Schema$ContinuousBackupInfo { /** - * Output only. The earliest restorable time that can be restored to. Output only field. + * Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided. */ earliestRestorableTime?: string | null; /** @@ -626,7 +626,7 @@ export namespace alloydb_v1alpha { */ encryptionInfo?: Schema$EncryptionInfo; /** - * Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request. + * Output only. Days of the week on which a continuous backup is taken. */ schedule?: string[] | null; } @@ -924,6 +924,10 @@ export namespace alloydb_v1alpha { * An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. */ export interface Schema$Instance { + /** + * Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details. + */ + activationPolicy?: string | null; /** * Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 */ @@ -1061,6 +1065,10 @@ export namespace alloydb_v1alpha { * Metadata related to instance-level network configuration. */ export interface Schema$InstanceNetworkConfig { + /** + * Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + */ + allocatedIpRangeOverride?: string | null; /** * Optional. A list of external network authorized to access this instance. */ diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 64a07093e3..89c6ff8381 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -602,7 +602,7 @@ export namespace alloydb_v1beta { */ export interface Schema$ContinuousBackupInfo { /** - * Output only. The earliest restorable time that can be restored to. Output only field. + * Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided. */ earliestRestorableTime?: string | null; /** @@ -614,7 +614,7 @@ export namespace alloydb_v1beta { */ encryptionInfo?: Schema$EncryptionInfo; /** - * Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request. + * Output only. Days of the week on which a continuous backup is taken. */ schedule?: string[] | null; } @@ -912,6 +912,10 @@ export namespace alloydb_v1beta { * An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. */ export interface Schema$Instance { + /** + * Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details. + */ + activationPolicy?: string | null; /** * Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 */ @@ -1045,6 +1049,10 @@ export namespace alloydb_v1beta { * Metadata related to instance-level network configuration. */ export interface Schema$InstanceNetworkConfig { + /** + * Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. + */ + allocatedIpRangeOverride?: string | null; /** * Optional. A list of external network authorized to access this instance. */ diff --git a/src/apis/analyticshub/v1.ts b/src/apis/analyticshub/v1.ts index 7b51e4d1a7..29621ce1e5 100644 --- a/src/apis/analyticshub/v1.ts +++ b/src/apis/analyticshub/v1.ts @@ -306,7 +306,7 @@ export namespace analyticshub_v1 { */ logLinkedDatasetQueryUserEmail?: boolean | null; /** - * Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ name?: string | null; /** @@ -385,10 +385,6 @@ export namespace analyticshub_v1 { * Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. */ location?: string | null; - /** - * Optional. The geographic locations where the dataset should be replicated. See https://cloud.google.com/bigquery/docs/locations for supported locations. - */ - replicaLocations?: string[] | null; } export interface Schema$DestinationDatasetReference { /** @@ -662,7 +658,7 @@ export namespace analyticshub_v1 { */ logLinkedDatasetQueryUserEmail?: boolean | null; /** - * Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` + * Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456` */ name?: string | null; /** @@ -1053,7 +1049,7 @@ export namespace analyticshub_v1 { */ export interface Schema$SubscribeDataExchangeRequest { /** - * Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/US` + * Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/us` */ destination?: string | null; /** @@ -1113,15 +1109,19 @@ export namespace analyticshub_v1 { */ creationTime?: string | null; /** - * Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 + * Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456 */ dataExchange?: string | null; + /** + * Optional. BigQuery destination dataset to create for the subscriber. + */ + destinationDataset?: Schema$DestinationDataset; /** * Output only. Timestamp when the subscription was last modified. */ lastModifyTime?: string | null; /** - * Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -\> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. + * Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -\> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. */ linkedDatasetMap?: {[key: string]: Schema$LinkedResource} | null; /** @@ -1129,7 +1129,7 @@ export namespace analyticshub_v1 { */ linkedResources?: Schema$LinkedResource[]; /** - * Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 + * Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789 */ listing?: string | null; /** @@ -1137,7 +1137,7 @@ export namespace analyticshub_v1 { */ logLinkedDatasetQueryUserEmail?: boolean | null; /** - * Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. + * Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`. */ name?: string | null; /** @@ -1312,7 +1312,7 @@ export namespace analyticshub_v1 { export interface Params$Resource$Organizations$Locations$Dataexchanges$List extends StandardParameters { /** - * Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`. + * Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/us`. */ organization?: string; /** @@ -2074,7 +2074,7 @@ export namespace analyticshub_v1 { } /** - * Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. + * Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2266,7 +2266,7 @@ export namespace analyticshub_v1 { */ dataExchangeId?: string; /** - * Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`. + * Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/us`. */ parent?: string; @@ -2278,14 +2278,14 @@ export namespace analyticshub_v1 { export interface Params$Resource$Projects$Locations$Dataexchanges$Delete extends StandardParameters { /** - * Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`. + * Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/us/dataExchanges/123`. */ name?: string; } export interface Params$Resource$Projects$Locations$Dataexchanges$Get extends StandardParameters { /** - * Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Required. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ name?: string; } @@ -2312,7 +2312,7 @@ export namespace analyticshub_v1 { */ pageToken?: string; /** - * Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`. + * Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/us`. */ parent?: string; } @@ -2331,14 +2331,14 @@ export namespace analyticshub_v1 { */ pageToken?: string; /** - * Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789 + * Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/us/dataExchanges/456 OR e.g. projects/123/locations/us/dataExchanges/456/listings/789 */ resource?: string; } export interface Params$Resource$Projects$Locations$Dataexchanges$Patch extends StandardParameters { /** - * Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ name?: string; /** @@ -2366,7 +2366,7 @@ export namespace analyticshub_v1 { export interface Params$Resource$Projects$Locations$Dataexchanges$Subscribe extends StandardParameters { /** - * Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123` + * Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/us/dataExchanges/123` */ name?: string; @@ -3311,7 +3311,7 @@ export namespace analyticshub_v1 { */ listingId?: string; /** - * Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ parent?: string; @@ -3327,14 +3327,14 @@ export namespace analyticshub_v1 { */ deleteCommercial?: boolean; /** - * Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. + * Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. */ name?: string; } export interface Params$Resource$Projects$Locations$Dataexchanges$Listings$Get extends StandardParameters { /** - * Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. + * Required. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. */ name?: string; } @@ -3361,7 +3361,7 @@ export namespace analyticshub_v1 { */ pageToken?: string; /** - * Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ parent?: string; } @@ -3380,14 +3380,14 @@ export namespace analyticshub_v1 { */ pageToken?: string; /** - * Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789 + * Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/us/dataExchanges/456 OR e.g. projects/123/locations/us/dataExchanges/456/listings/789 */ resource?: string; } export interface Params$Resource$Projects$Locations$Dataexchanges$Listings$Patch extends StandardParameters { /** - * Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` + * Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456` */ name?: string; /** @@ -3415,7 +3415,7 @@ export namespace analyticshub_v1 { export interface Params$Resource$Projects$Locations$Dataexchanges$Listings$Subscribe extends StandardParameters { /** - * Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. + * Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. */ name?: string; @@ -4070,14 +4070,14 @@ export namespace analyticshub_v1 { export interface Params$Resource$Projects$Locations$Subscriptions$Delete extends StandardParameters { /** - * Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456 + * Required. Resource name of the subscription to delete. e.g. projects/123/locations/us/subscriptions/456 */ name?: string; } export interface Params$Resource$Projects$Locations$Subscriptions$Get extends StandardParameters { /** - * Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456 + * Required. Resource name of the subscription. e.g. projects/123/locations/us/subscriptions/456 */ name?: string; } @@ -4108,14 +4108,14 @@ export namespace analyticshub_v1 { */ pageToken?: string; /** - * Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US + * Required. The parent resource path of the subscription. e.g. projects/myproject/locations/us */ parent?: string; } export interface Params$Resource$Projects$Locations$Subscriptions$Refresh extends StandardParameters { /** - * Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123` + * Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/us/subscriptions/123` */ name?: string; @@ -4127,7 +4127,7 @@ export namespace analyticshub_v1 { export interface Params$Resource$Projects$Locations$Subscriptions$Revoke extends StandardParameters { /** - * Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456 + * Required. Resource name of the subscription to revoke. e.g. projects/123/locations/us/subscriptions/456 */ name?: string; diff --git a/src/apis/analyticshub/v1beta1.ts b/src/apis/analyticshub/v1beta1.ts index 882bcfbf1d..4488fd73b3 100644 --- a/src/apis/analyticshub/v1beta1.ts +++ b/src/apis/analyticshub/v1beta1.ts @@ -212,7 +212,7 @@ export namespace analyticshub_v1beta1 { */ listingCount?: number | null; /** - * Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ name?: string | null; /** @@ -233,6 +233,41 @@ export namespace analyticshub_v1beta1 { */ primaryContact?: string | null; } + /** + * Defines the destination bigquery dataset. + */ + export interface Schema$DestinationDataset { + /** + * Required. A reference that identifies the destination dataset. + */ + datasetReference?: Schema$DestinationDatasetReference; + /** + * Optional. A user-friendly description of the dataset. + */ + description?: string | null; + /** + * Optional. A descriptive name for the dataset. + */ + friendlyName?: string | null; + /** + * Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + */ + location?: string | null; + } + export interface Schema$DestinationDatasetReference { + /** + * Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + */ + datasetId?: string | null; + /** + * Required. The ID of the project containing this dataset. + */ + projectId?: 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); \} */ @@ -387,7 +422,7 @@ export namespace analyticshub_v1beta1 { */ icon?: string | null; /** - * Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` + * Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456` */ name?: string | null; /** @@ -578,15 +613,19 @@ export namespace analyticshub_v1beta1 { */ creationTime?: string | null; /** - * Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 + * Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456 */ dataExchange?: string | null; + /** + * Optional. BigQuery destination dataset to create for the subscriber. + */ + destinationDataset?: Schema$DestinationDataset; /** * Output only. Timestamp when the subscription was last modified. */ lastModifyTime?: string | null; /** - * Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -\> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. + * Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -\> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. */ linkedDatasetMap?: {[key: string]: Schema$LinkedResource} | null; /** @@ -594,7 +633,7 @@ export namespace analyticshub_v1beta1 { */ linkedResources?: Schema$LinkedResource[]; /** - * Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 + * Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789 */ listing?: string | null; /** @@ -602,7 +641,7 @@ export namespace analyticshub_v1beta1 { */ logLinkedDatasetQueryUserEmail?: boolean | null; /** - * Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. + * Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`. */ name?: string | null; /** @@ -773,7 +812,7 @@ export namespace analyticshub_v1beta1 { export interface Params$Resource$Organizations$Locations$Dataexchanges$List extends StandardParameters { /** - * Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`. + * Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/us`. */ organization?: string; /** @@ -1536,7 +1575,7 @@ export namespace analyticshub_v1beta1 { */ dataExchangeId?: string; /** - * Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`. + * Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/us`. */ parent?: string; @@ -1548,14 +1587,14 @@ export namespace analyticshub_v1beta1 { export interface Params$Resource$Projects$Locations$Dataexchanges$Delete extends StandardParameters { /** - * Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`. + * Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/us/dataExchanges/123`. */ name?: string; } export interface Params$Resource$Projects$Locations$Dataexchanges$Get extends StandardParameters { /** - * Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Required. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ name?: string; } @@ -1582,14 +1621,14 @@ export namespace analyticshub_v1beta1 { */ pageToken?: string; /** - * Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`. + * Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/us`. */ parent?: string; } export interface Params$Resource$Projects$Locations$Dataexchanges$Patch extends StandardParameters { /** - * Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ name?: string; /** @@ -2452,7 +2491,7 @@ export namespace analyticshub_v1beta1 { */ listingId?: string; /** - * Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ parent?: string; @@ -2464,14 +2503,14 @@ export namespace analyticshub_v1beta1 { export interface Params$Resource$Projects$Locations$Dataexchanges$Listings$Delete extends StandardParameters { /** - * Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. + * Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. */ name?: string; } export interface Params$Resource$Projects$Locations$Dataexchanges$Listings$Get extends StandardParameters { /** - * Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. + * Required. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. */ name?: string; } @@ -2498,14 +2537,14 @@ export namespace analyticshub_v1beta1 { */ pageToken?: string; /** - * Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. + * Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`. */ parent?: string; } export interface Params$Resource$Projects$Locations$Dataexchanges$Listings$Patch extends StandardParameters { /** - * Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` + * Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456` */ name?: string; /** @@ -2533,7 +2572,7 @@ export namespace analyticshub_v1beta1 { export interface Params$Resource$Projects$Locations$Dataexchanges$Listings$Subscribe extends StandardParameters { /** - * Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. + * Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. */ name?: string; diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 510273a740..74f16c5c7c 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -196,6 +196,104 @@ export namespace androidmanagement_v1 { */ minApiLevel?: number | null; } + /** + * Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. + */ + export interface Schema$ApnPolicy { + /** + * Optional. APN settings for override APNs. There must not be any conflict between any of APN settings provided, otherwise the policy will be rejected. Two ApnSettings are considered to conflict when all of the following fields match on both: numericOperatorId, apn, proxyAddress, proxyPort, mmsProxyAddress, mmsProxyPort, mmsc, mvnoType, protocol, roamingProtocol. If some of the APN settings result in non-compliance of INVALID_VALUE , they will be ignored. This can be set on fully managed devices on Android 10 and above. This can also be set on work profiles on Android 13 and above and only with ApnSetting's with ENTERPRISE APN type. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 10. A nonComplianceDetail with MANAGEMENT_MODE is reported for work profiles on Android versions less than 13. + */ + apnSettings?: Schema$ApnSetting[]; + /** + * Optional. Whether override APNs are disabled or enabled. See DevicePolicyManager.setOverrideApnsEnabled (https://developer.android.com/reference/android/app/admin/DevicePolicyManager#setOverrideApnsEnabled) for more details. + */ + overrideApns?: string | null; + } + /** + * An Access Point Name (APN) configuration for a carrier data connection. The APN provides configuration to connect a cellular network device to an IP data network. A carrier uses this setting to decide which IP address to assign, any security methods to apply, and how the device might be connected to private networks. + */ + export interface Schema$ApnSetting { + /** + * Optional. Whether User Plane resources have to be activated during every transition from CM-IDLE mode to CM-CONNECTED state for this APN. See 3GPP TS 23.501 section 5.6.13. + */ + alwaysOnSetting?: string | null; + /** + * Required. Name of the APN. Policy will be rejected if this field is empty. + */ + apn?: string | null; + /** + * Required. Usage categories for the APN. Policy will be rejected if this field is empty or contains APN_TYPE_UNSPECIFIED or duplicates. Multiple APN types can be set on fully managed devices. ENTERPRISE is the only allowed APN type on work profiles. A nonComplianceDetail with MANAGEMENT_MODE is reported for any other value on work profiles. APN types that are not supported on the device or management mode will be ignored. If this results in the empty list, the APN setting will be ignored, because apnTypes is a required field. A nonComplianceDetail with INVALID_VALUE is reported if none of the APN types are supported on the device or management mode. + */ + apnTypes?: string[] | null; + /** + * Optional. Authentication type of the APN. + */ + authType?: string | null; + /** + * Optional. Carrier ID for the APN. A value of 0 (default) means not set and negative values are rejected. + */ + carrierId?: number | null; + /** + * Required. Human-readable name that describes the APN. Policy will be rejected if this field is empty. + */ + displayName?: string | null; + /** + * Optional. MMSC (Multimedia Messaging Service Center) URI of the APN. + */ + mmsc?: string | null; + /** + * Optional. MMS (Multimedia Messaging Service) proxy address of the APN which can be an IP address or hostname (not a URL). + */ + mmsProxyAddress?: string | null; + /** + * Optional. MMS (Multimedia Messaging Service) proxy port of the APN. A value of 0 (default) means not set and negative values are rejected. + */ + mmsProxyPort?: number | null; + /** + * Optional. The default MTU (Maximum Transmission Unit) size in bytes of the IPv4 routes brought up by this APN setting. A value of 0 (default) means not set and negative values are rejected. Supported on Android 13 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 13. + */ + mtuV4?: number | null; + /** + * Optional. The MTU (Maximum Transmission Unit) size of the IPv6 mobile interface to which the APN connected. A value of 0 (default) means not set and negative values are rejected. Supported on Android 13 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 13. + */ + mtuV6?: number | null; + /** + * Optional. MVNO match type for the APN. + */ + mvnoType?: string | null; + /** + * Optional. Radio technologies (network types) the APN may use. Policy will be rejected if this field contains NETWORK_TYPE_UNSPECIFIED or duplicates. + */ + networkTypes?: string[] | null; + /** + * Optional. The numeric operator ID of the APN. Numeric operator ID is defined as MCC (Mobile Country Code) + MNC (Mobile Network Code). + */ + numericOperatorId?: string | null; + /** + * Optional. APN password of the APN. + */ + password?: string | null; + /** + * Optional. The protocol to use to connect to this APN. + */ + protocol?: string | null; + /** + * Optional. The proxy address of the APN. + */ + proxyAddress?: string | null; + /** + * Optional. The proxy port of the APN. A value of 0 (default) means not set and negative values are rejected. + */ + proxyPort?: number | null; + /** + * Optional. The protocol to use to connect to this APN while the device is roaming. + */ + roamingProtocol?: string | null; + /** + * Optional. APN username of the APN. + */ + username?: string | null; + } /** * Information about an app. */ @@ -395,6 +493,10 @@ export namespace androidmanagement_v1 { * Explicit permission grants or denials for the app. These values override the default_permission_policy and permission_grants which apply to all apps. */ permissionGrants?: Schema$PermissionGrant[]; + /** + * Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above. + */ + preferentialNetworkId?: string | null; /** * Optional. Specifies whether user control is permitted for the app. User control includes user actions like force-stopping and clearing app data. Supported on Android 11 and above. */ @@ -1041,6 +1143,10 @@ export namespace androidmanagement_v1 { * Covers controls for device connectivity such as Wi-Fi, USB data access, keyboard/mouse connections, and more. */ export interface Schema$DeviceConnectivityManagement { + /** + * Optional. Access Point Name (APN) policy. Configuration for Access Point Names (APNs) which may override any other APNs on the device. See OVERRIDE_APNS_ENABLED and overrideApns for details. + */ + apnPolicy?: Schema$ApnPolicy; /** * Optional. Controls whether Bluetooth sharing is allowed. */ @@ -1049,6 +1155,10 @@ export namespace androidmanagement_v1 { * Controls Wi-Fi configuring privileges. Based on the option set, user will have either full or limited or no control in configuring Wi-Fi networks. */ configureWifi?: string | null; + /** + * Optional. Preferential network service configuration. Setting this field will override preferentialNetworkService. This can be set on both work profiles and fully managed devices on Android 13 and above. + */ + preferentialNetworkServiceSettings?: Schema$PreferentialNetworkServiceSettings; /** * Controls tethering settings. Based on the value set, the user is partially or fully disallowed from using different forms of tethering. */ @@ -2465,6 +2575,10 @@ export namespace androidmanagement_v1 { * Whether app verification is force-enabled. */ ensureVerifyAppsEnabled?: boolean | null; + /** + * Optional. Controls whether the enterpriseDisplayName is visible on the device (e.g. lock screen message on company-owned devices). + */ + enterpriseDisplayNameVisibility?: string | null; /** * Whether factory resetting from settings is disabled. */ @@ -2598,7 +2712,7 @@ export namespace androidmanagement_v1 { */ policyEnforcementRules?: Schema$PolicyEnforcementRule[]; /** - * Controls whether preferential network service is enabled on the work profile. For example, an organization may have an agreement with a carrier that all of the work data from its employees' devices will be sent via a network service dedicated for enterprise use. An example of a supported preferential network service is the enterprise slice on 5G networks. This has no effect on fully managed devices. + * Controls whether preferential network service is enabled on the work profile or on fully managed devices. For example, an organization may have an agreement with a carrier that all of the work data from its employees' devices will be sent via a network service dedicated for enterprise use. An example of a supported preferential network service is the enterprise slice on 5G networks. This policy has no effect if preferentialNetworkServiceSettings or ApplicationPolicy.preferentialNetworkId is set on devices running Android 13 or above. */ preferentialNetworkService?: string | null; /** @@ -2757,6 +2871,36 @@ export namespace androidmanagement_v1 { */ eventType?: string | null; } + /** + * Individual preferential network service configuration. + */ + export interface Schema$PreferentialNetworkServiceConfig { + /** + * Optional. Whether fallback to the device-wide default network is allowed. If this is set to FALLBACK_TO_DEFAULT_CONNECTION_ALLOWED, then nonMatchingNetworks must not be set to NON_MATCHING_NETWORKS_DISALLOWED, the policy will be rejected otherwise. Note: If this is set to FALLBACK_TO_DEFAULT_CONNECTION_DISALLOWED, applications are not able to access the internet if the 5G slice is not available. + */ + fallbackToDefaultConnection?: string | null; + /** + * Optional. Whether apps this configuration applies to are blocked from using networks other than the preferential service. If this is set to NON_MATCHING_NETWORKS_DISALLOWED, then fallbackToDefaultConnection must be set to FALLBACK_TO_DEFAULT_CONNECTION_DISALLOWED. + */ + nonMatchingNetworks?: string | null; + /** + * Required. Preferential network identifier. This must not be set to NO_PREFERENTIAL_NETWORK or PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the policy will be rejected otherwise. + */ + preferentialNetworkId?: string | null; + } + /** + * Preferential network service settings. + */ + export interface Schema$PreferentialNetworkServiceSettings { + /** + * Required. Default preferential network ID for the applications that are not in applications or if ApplicationPolicy.preferentialNetworkId is set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs, unless this is set to NO_PREFERENTIAL_NETWORK. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED or unset, this defaults to NO_PREFERENTIAL_NETWORK. Note: If the default preferential network is misconfigured, applications with no ApplicationPolicy.preferentialNetworkId set are not able to access the internet. This setting does not apply to the following critical apps: com.google.android.apps.work.clouddpc com.google.android.gmsApplicationPolicy.preferentialNetworkId can still be used to configure the preferential network for them. + */ + defaultPreferentialNetworkId?: string | null; + /** + * Required. Preferential network service configurations which enables having multiple enterprise slices. There must not be multiple configurations with the same preferentialNetworkId. If a configuration is not referenced by any application by setting ApplicationPolicy.preferentialNetworkId or by setting defaultPreferentialNetworkId, it will be ignored. For devices on 4G networks, enterprise APN needs to be configured additionally to set up data call for preferential network service. These APNs can be added using apnPolicy. + */ + preferentialNetworkServiceConfigs?: Schema$PreferentialNetworkServiceConfig[]; + } /** * Information about a device that is available during setup. */ @@ -4273,7 +4417,7 @@ export namespace androidmanagement_v1 { } /** - * Deletes a device. This operation wipes the device. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get. + * Deletes a device. This operation attempts to wipe the device but this is not guaranteed to succeed if the device is offline for an extended period. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 22b224f0d2..b7f1e84130 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -603,6 +603,15 @@ export namespace androidpublisher_v3 { */ state?: string | null; } + /** + * Response for the orders.batchGet API. + */ + export interface Schema$BatchGetOrdersResponse { + /** + * Details for the requested order IDs. + */ + orders?: Schema$Order[]; + } /** * Request message for BatchGetSubscriptionOffers endpoint. */ @@ -747,6 +756,23 @@ export namespace androidpublisher_v3 { */ kind?: string | null; } + /** + * Address information for the customer, for use in tax computation. + */ + export interface Schema$BuyerAddress { + /** + * Two letter country code based on ISO-3166-1 Alpha-2 (UN country codes). + */ + buyerCountry?: string | null; + /** + * Postal code of an address. When Google is the Merchant of Record for the order, this information is not included. + */ + buyerPostcode?: string | null; + /** + * Top-level administrative subdivision of the buyer address country. When Google is the Merchant of Record for the order, this information is not included. + */ + buyerState?: string | null; + } /** * Request message for CancelAppRecovery. */ @@ -776,6 +802,15 @@ export namespace androidpublisher_v3 { */ userInitiatedCancellation?: Schema$UserInitiatedCancellation; } + /** + * Details of when the order was canceled. + */ + export interface Schema$CancellationEvent { + /** + * The time when the order was canceled. + */ + eventTime?: string | null; + } /** * Result of the cancel survey when the subscription was canceled by the user. */ @@ -1871,6 +1906,43 @@ export namespace androidpublisher_v3 { */ value?: string[] | null; } + /** + * Details of a line item. + */ + export interface Schema$LineItem { + /** + * Item's listed price on Play Store, this may or may not include tax. Excludes any discounts or promotions. + */ + listingPrice?: Schema$Money; + /** + * Details of a one-time purchase. + */ + oneTimePurchaseDetails?: Schema$OneTimePurchaseDetails; + /** + * Details of a paid app purchase. + */ + paidAppDetails?: Schema$PaidAppDetails; + /** + * The purchased product ID or in-app SKU (for example, 'monthly001' or 'com.some.thing.inapp1'). + */ + productId?: string | null; + /** + * Developer-specified name of the product. Displayed in buyer's locale. Example: coins, monthly subscription, etc. + */ + productTitle?: string | null; + /** + * Details of a subscription purchase. + */ + subscriptionDetails?: Schema$SubscriptionDetails; + /** + * The tax paid for this line item. + */ + tax?: Schema$Money; + /** + * The total amount paid by the user for this line item, taking into account discounts and tax. + */ + total?: Schema$Money; + } /** * Response message for ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled */ @@ -2155,6 +2227,106 @@ export namespace androidpublisher_v3 { */ externalTransactionToken?: string | null; } + /** + * Details of a one-time purchase. + */ + export interface Schema$OneTimePurchaseDetails { + /** + * The offer ID of the one-time purchase offer. + */ + offerId?: string | null; + /** + * The number of items purchased (for multi-quantity item purchases). + */ + quantity?: number | null; + } + /** + * Details of an order. + */ + export interface Schema$Order { + /** + * Address information for the customer, for use in tax computation. When Google is the Merchant of Record for the order, only country is shown. + */ + buyerAddress?: Schema$BuyerAddress; + /** + * The time when the order was created. + */ + createTime?: string | null; + /** + * Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees. Google deducts standard transaction and third party fees from each sale, including VAT in some regions. + */ + developerRevenueInBuyerCurrency?: Schema$Money; + /** + * The time of the last event that occurred on the order. + */ + lastEventTime?: string | null; + /** + * The individual line items making up this order. + */ + lineItems?: Schema$LineItem[]; + /** + * Detailed information about the order at creation time. + */ + orderDetails?: Schema$OrderDetails; + /** + * Details about events which modified the order. + */ + orderHistory?: Schema$OrderHistory; + /** + * The order ID. + */ + orderId?: string | null; + /** + * Play points applied to the order, including offer information, discount rate and point values. + */ + pointsDetails?: Schema$PointsDetails; + /** + * The token provided to the user's device when the subscription or item was purchased. + */ + purchaseToken?: string | null; + /** + * The state of the order. + */ + state?: string | null; + /** + * The total tax paid as a part of this order. + */ + tax?: Schema$Money; + /** + * The final amount paid by the customer, taking into account discounts and taxes. + */ + total?: Schema$Money; + } + /** + * Detailed information about the order at creation time. + */ + export interface Schema$OrderDetails { + /** + * Indicates whether the listed price was tax inclusive or not. + */ + taxInclusive?: boolean | null; + } + /** + * Details about events which modified the order. + */ + export interface Schema$OrderHistory { + /** + * Details of when the order was canceled. + */ + cancellationEvent?: Schema$CancellationEvent; + /** + * Details of the partial refund events for this order. + */ + partialRefundEvents?: Schema$PartialRefundEvent[]; + /** + * Details of when the order was processed. + */ + processedEvent?: Schema$ProcessedEvent; + /** + * Details of when the order was fully refunded. + */ + refundEvent?: Schema$RefundEvent; + } /** * Details of a recurring external transaction product which doesn't belong to any other more specific category. */ @@ -2240,6 +2412,10 @@ export namespace androidpublisher_v3 { */ totalResults?: number | null; } + /** + * Details of a paid app purchase. + */ + export interface Schema$PaidAppDetails {} /** * A partial refund of a transaction. */ @@ -2253,6 +2429,27 @@ export namespace androidpublisher_v3 { */ refundPreTaxAmount?: Schema$Price; } + /** + * Details of the partial refund events for this order. + */ + export interface Schema$PartialRefundEvent { + /** + * The time when the partial refund was created. + */ + createTime?: string | null; + /** + * The time when the partial refund was processed. + */ + processTime?: string | null; + /** + * Details for the partial refund. + */ + refundDetails?: Schema$RefundDetails; + /** + * The state of the partial refund. + */ + state?: string | null; + } /** * Information specific to a subscription in paused state. */ @@ -2266,6 +2463,27 @@ export namespace androidpublisher_v3 { * This is an indicator of whether there is a pending cancellation on the virtual installment plan. The cancellation will happen only after the user finished all committed payments. */ export interface Schema$PendingCancellation {} + /** + * Details relating to any Play Points applied to an order. + */ + export interface Schema$PointsDetails { + /** + * The monetary value of a Play Points coupon. This is the discount the coupon provides, which may not be the total amount. Only set when Play Points coupons have been used. E.g. for a 100 points for $2 coupon, this is $2. + */ + pointsCouponValue?: Schema$Money; + /** + * The percentage rate which the Play Points promotion reduces the cost by. E.g. for a 100 points for $2 coupon, this is 500,000. Since $2 has an estimate of 200 points, but the actual Points required, 100, is 50% of this, and 50% in micros is 500,000. Between 0 and 1,000,000. + */ + pointsDiscountRateMicros?: string | null; + /** + * ID unique to the play points offer in use for this order. + */ + pointsOfferId?: string | null; + /** + * The number of Play Points applied in this order. E.g. for a 100 points for $2 coupon, this is 100. For coupon stacked with base offer, this is the total points spent across both. + */ + pointsSpent?: string | null; + } /** * Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. */ @@ -2301,6 +2519,15 @@ export namespace androidpublisher_v3 { */ priceMicros?: string | null; } + /** + * Details of when the order was processed. + */ + export interface Schema$ProcessedEvent { + /** + * The time when the order was processed. + */ + eventTime?: string | null; + } /** * A ProductPurchase resource indicates the status of a user's inapp product purchase. */ @@ -2400,6 +2627,36 @@ export namespace androidpublisher_v3 { */ otherRecurringProduct?: Schema$OtherRecurringProduct; } + /** + * Details for a partial or full refund. + */ + export interface Schema$RefundDetails { + /** + * The amount of tax refunded. + */ + tax?: Schema$Money; + /** + * The total amount refunded, including tax. + */ + total?: Schema$Money; + } + /** + * Details of when the order was fully refunded. + */ + export interface Schema$RefundEvent { + /** + * The time when the order was fully refunded. + */ + eventTime?: string | null; + /** + * Details for the full refund. + */ + refundDetails?: Schema$RefundDetails; + /** + * The reason the order was refunded. + */ + refundReason?: string | null; + } /** * A request to refund an existing external transaction. */ @@ -2524,7 +2781,7 @@ export namespace androidpublisher_v3 { */ export interface Schema$RegionsVersion { /** - * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02. + * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. */ version?: string | null; } @@ -2649,6 +2906,10 @@ export namespace androidpublisher_v3 { * Optional. Used when users should be refunded the full amount of the latest order of the subscription. */ fullRefund?: Schema$RevocationContextFullRefund; + /** + * Optional. Used when a specific item should be refunded in a subscription with multiple items. + */ + itemBasedRefund?: Schema$RevocationContextItemBasedRefund; /** * Optional. Used when users should be refunded a prorated amount they paid for their subscription based on the amount of time remaining in a subscription. */ @@ -2658,6 +2919,15 @@ export namespace androidpublisher_v3 { * Used to determine if the refund type in the RevocationContext is a full refund. */ export interface Schema$RevocationContextFullRefund {} + /** + * Used to determine what specific item to revoke in a subscription with multiple items. + */ + export interface Schema$RevocationContextItemBasedRefund { + /** + * Required. If the subscription is a subscription bundle, the product id of the subscription to revoke. + */ + productId?: string | null; + } /** * Used to determine if the refund type in the RevocationContext is a prorated refund. */ @@ -2872,6 +3142,31 @@ export namespace androidpublisher_v3 { */ expectedExpiryTimeMillis?: string | null; } + /** + * Details of a subscription purchase. + */ + export interface Schema$SubscriptionDetails { + /** + * The base plan ID of the subscription. + */ + basePlanId?: string | null; + /** + * The offer ID for the current subscription offer. + */ + offerId?: string | null; + /** + * The pricing phase for the billing period funded by this order. + */ + offerPhase?: string | null; + /** + * The end of the billing period funded by this order. This is a snapshot of the billing/service period end time at the moment the order was processed, and should be used only for accounting. To get the current end time of the subscription service period, use purchases.subscriptionsv2.get. + */ + servicePeriodEndTime?: string | null; + /** + * The start of the billing period funded by this order. This is a snapshot of the billing/service period start time at the moment the order was processed, and should be used only for accounting. + */ + servicePeriodStartTime?: string | null; + } /** * Price change related information of a subscription item. */ @@ -12116,7 +12411,7 @@ export namespace androidpublisher_v3 { */ productId?: string; /** - * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02. + * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. */ 'regionsVersion.version'?: string; @@ -12185,7 +12480,7 @@ export namespace androidpublisher_v3 { */ productId?: string; /** - * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02. + * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. */ 'regionsVersion.version'?: string; /** @@ -13942,7 +14237,7 @@ export namespace androidpublisher_v3 { */ productId?: string; /** - * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02. + * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. */ 'regionsVersion.version'?: string; @@ -14063,7 +14358,7 @@ export namespace androidpublisher_v3 { */ productId?: string; /** - * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02. + * Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. */ 'regionsVersion.version'?: string; /** @@ -14083,6 +14378,189 @@ export namespace androidpublisher_v3 { this.context = context; } + /** + * Get order details for a list of orders. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchget( + params: Params$Resource$Orders$Batchget, + options: StreamMethodOptions + ): GaxiosPromise; + batchget( + params?: Params$Resource$Orders$Batchget, + options?: MethodOptions + ): GaxiosPromise; + batchget( + params: Params$Resource$Orders$Batchget, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchget( + params: Params$Resource$Orders$Batchget, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchget( + params: Params$Resource$Orders$Batchget, + callback: BodyResponseCallback + ): void; + batchget( + callback: BodyResponseCallback + ): void; + batchget( + paramsOrCallback?: + | Params$Resource$Orders$Batchget + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Orders$Batchget; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orders$Batchget; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://androidpublisher.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/orders:batchGet' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['packageName'], + pathParams: ['packageName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get order details for a single order. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Orders$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Orders$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Orders$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Orders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Orders$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Orders$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Orders$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orders$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://androidpublisher.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/orders/{orderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['packageName', 'orderId'], + pathParams: ['orderId', 'packageName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded. * @@ -14170,6 +14648,26 @@ export namespace androidpublisher_v3 { } } + export interface Params$Resource$Orders$Batchget extends StandardParameters { + /** + * Required. The list of order IDs to retrieve order details for. There must be between 1 and 1000 (inclusive) order IDs per request. If any order ID is not found or does not match the provided package, the entire request will fail with an error. The order IDs must be distinct. + */ + orderIds?: string[]; + /** + * Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). + */ + packageName?: string; + } + export interface Params$Resource$Orders$Get extends StandardParameters { + /** + * Required. The order ID provided to the user when the subscription or in-app order was purchased. + */ + orderId?: string; + /** + * Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). + */ + packageName?: string; + } export interface Params$Resource$Orders$Refund extends StandardParameters { /** * The order ID provided to the user when the subscription or in-app order was purchased. diff --git a/src/apis/apihub/README.md b/src/apis/apihub/README.md new file mode 100644 index 0000000000..9215be6813 --- /dev/null +++ b/src/apis/apihub/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# apihub + +> + +## Installation + +```sh +$ npm install @googleapis/apihub +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/apihub/classes/Apihub.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/apihub/index.ts b/src/apis/apihub/index.ts new file mode 100644 index 0000000000..5264c812da --- /dev/null +++ b/src/apis/apihub/index.ts @@ -0,0 +1,44 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {apihub_v1} from './v1'; + +export const VERSIONS = { + v1: apihub_v1.Apihub, +}; + +export function apihub(version: 'v1'): apihub_v1.Apihub; +export function apihub(options: apihub_v1.Options): apihub_v1.Apihub; +export function apihub( + this: GoogleConfigurable, + versionOrOptions: 'v1' | apihub_v1.Options +) { + return getAPI('apihub', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {apihub_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/apihub/package.json b/src/apis/apihub/package.json new file mode 100644 index 0000000000..8c89b447ea --- /dev/null +++ b/src/apis/apihub/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/apihub", + "version": "0.1.0", + "description": "apihub", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/apihub/tsconfig.json b/src/apis/apihub/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/apihub/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/apihub/v1.ts b/src/apis/apihub/v1.ts new file mode 100644 index 0000000000..71c62d8093 --- /dev/null +++ b/src/apis/apihub/v1.ts @@ -0,0 +1,11333 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace apihub_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * API hub API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const apihub = google.apihub('v1'); + * ``` + */ + export class Apihub { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * 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 details for the action to execute. + */ + export interface Schema$GoogleCloudApihubV1ActionExecutionDetail { + /** + * Required. The action id of the plugin to execute. + */ + actionId?: string | null; + } + /** + * The value that can be assigned to the attribute when the data type is enum. + */ + export interface Schema$GoogleCloudApihubV1AllowedValue { + /** + * Optional. The detailed description of the allowed value. + */ + description?: string | null; + /** + * Required. The display name of the allowed value. + */ + displayName?: string | null; + /** + * Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. + */ + id?: string | null; + /** + * Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. + */ + immutable?: boolean | null; + } + /** + * An API resource in the API Hub. + */ + export interface Schema$GoogleCloudApihubV1Api { + /** + * Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. + */ + apiFunctionalRequirements?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. + */ + apiRequirements?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Optional. The style of the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + apiStyle?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. + */ + apiTechnicalRequirements?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource. + */ + attributes?: { + [key: string]: Schema$GoogleCloudApihubV1AttributeValues; + } | null; + /** + * Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + businessUnit?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Output only. The time at which the API resource was created. + */ + createTime?: string | null; + /** + * Optional. The description of the API resource. + */ + description?: string | null; + /** + * Required. The display name of the API resource. + */ + displayName?: string | null; + /** + * Optional. The documentation for the API resource. + */ + documentation?: Schema$GoogleCloudApihubV1Documentation; + /** + * Optional. Fingerprint of the API resource. + */ + fingerprint?: string | null; + /** + * Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + maturityLevel?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Identifier. The name of the API resource in the API Hub. Format: `projects/{project\}/locations/{location\}/apis/{api\}` + */ + name?: string | null; + /** + * Optional. Owner details for the API resource. + */ + owner?: Schema$GoogleCloudApihubV1Owner; + /** + * Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + selectedVersion?: string | null; + /** + * Output only. The list of sources and metadata from the sources of the API resource. + */ + sourceMetadata?: Schema$GoogleCloudApihubV1SourceMetadata[]; + /** + * Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + targetUser?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + team?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Output only. The time at which the API resource was last updated. + */ + updateTime?: string | null; + /** + * Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + versions?: string[] | null; + } + /** + * The API data to be collected. + */ + export interface Schema$GoogleCloudApihubV1ApiData { + /** + * Optional. The list of API metadata. + */ + apiMetadataList?: Schema$GoogleCloudApihubV1ApiMetadataList; + } + /** + * An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project. + */ + export interface Schema$GoogleCloudApihubV1ApiHubInstance { + /** + * Required. Config of the ApiHub instance. + */ + config?: Schema$GoogleCloudApihubV1Config; + /** + * Output only. Creation timestamp. + */ + createTime?: string | null; + /** + * Optional. Description of the ApiHub instance. + */ + description?: string | null; + /** + * Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. Format: `projects/{project\}/locations/{location\}/apiHubInstances/{apiHubInstance\}`. + */ + name?: string | null; + /** + * Output only. The current state of the ApiHub instance. + */ + state?: string | null; + /** + * Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`. + */ + stateMessage?: string | null; + /** + * Output only. Last update timestamp. + */ + updateTime?: string | null; + } + /** + * ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub. + */ + export interface Schema$GoogleCloudApihubV1ApiHubResource { + /** + * This represents Api resource in search results. Only name, display_name, description and owner fields are populated in search results. + */ + api?: Schema$GoogleCloudApihubV1Api; + /** + * This represents Definition resource in search results. Only name field is populated in search results. + */ + definition?: Schema$GoogleCloudApihubV1Definition; + /** + * This represents Deployment resource in search results. Only name, display_name, description, deployment_type and api_versions fields are populated in search results. + */ + deployment?: Schema$GoogleCloudApihubV1Deployment; + /** + * This represents ApiOperation resource in search results. Only name, description, spec and details fields are populated in search results. + */ + operation?: Schema$GoogleCloudApihubV1ApiOperation; + /** + * This represents Spec resource in search results. Only name, display_name, description, spec_type and documentation fields are populated in search results. + */ + spec?: Schema$GoogleCloudApihubV1Spec; + /** + * This represents Version resource in search results. Only name, display_name, description, lifecycle, compliance and accreditation fields are populated in search results. + */ + version?: Schema$GoogleCloudApihubV1Version; + } + /** + * Config for authentication with API key. + */ + export interface Schema$GoogleCloudApihubV1ApiKeyConfig { + /** + * Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project\}/secrets/{secrete\}/versions/{version\}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret. + */ + apiKey?: Schema$GoogleCloudApihubV1Secret; + /** + * Required. The location of the API key. The default value is QUERY. + */ + 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; + } + /** + * The API metadata. + */ + export interface Schema$GoogleCloudApihubV1APIMetadata { + /** + * Required. The API resource to be pushed to Hub's collect layer. The ID of the API resource will be generated by Hub to ensure uniqueness across all APIs across systems. + */ + api?: Schema$GoogleCloudApihubV1Api; + /** + * Optional. Timestamp indicating when the API was created at the source. + */ + originalCreateTime?: string | null; + /** + * Optional. The unique identifier of the API in the system where it was originally created. + */ + originalId?: string | null; + /** + * Required. Timestamp indicating when the API was last updated at the source. + */ + originalUpdateTime?: string | null; + /** + * Optional. The list of versions present in an API resource. + */ + versions?: Schema$GoogleCloudApihubV1VersionMetadata[]; + } + /** + * The message to hold repeated API metadata. + */ + export interface Schema$GoogleCloudApihubV1ApiMetadataList { + /** + * Required. The list of API metadata. + */ + apiMetadata?: Schema$GoogleCloudApihubV1APIMetadata[]; + } + /** + * Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API. + */ + export interface Schema$GoogleCloudApihubV1ApiOperation { + /** + * Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource. + */ + attributes?: { + [key: string]: Schema$GoogleCloudApihubV1AttributeValues; + } | null; + /** + * Output only. The time at which the operation was created. + */ + createTime?: string | null; + /** + * Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. + */ + details?: Schema$GoogleCloudApihubV1OperationDetails; + /** + * Identifier. The name of the operation. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/operations/{operation\}` + */ + name?: string | null; + /** + * Output only. The list of sources and metadata from the sources of the API operation. + */ + sourceMetadata?: Schema$GoogleCloudApihubV1SourceMetadata[]; + /** + * Output only. The name of the spec will be of the format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API. + */ + spec?: string | null; + /** + * Output only. The time at which the operation was last updated. + */ + updateTime?: string | null; + } + /** + * The details of the Application Integration endpoint to be triggered for curation. + */ + export interface Schema$GoogleCloudApihubV1ApplicationIntegrationEndpointDetails { + /** + * Required. The API trigger ID of the Application Integration workflow. + */ + triggerId?: string | null; + /** + * Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/x/locations/x/integrations/x\}:execute` or `https://{location\}-integrations.googleapis.com/v1/{name=projects/x/locations/x/integrations/x\}:execute` + */ + uri?: string | null; + } + /** + * An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users. + */ + export interface Schema$GoogleCloudApihubV1Attribute { + /** + * Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000. + */ + allowedValues?: Schema$GoogleCloudApihubV1AllowedValue[]; + /** + * Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute. + */ + cardinality?: number | null; + /** + * Output only. The time at which the attribute was created. + */ + createTime?: string | null; + /** + * Required. The type of the data of the attribute. + */ + dataType?: string | null; + /** + * Output only. The definition type of the attribute. + */ + definitionType?: string | null; + /** + * Optional. The description of the attribute. + */ + description?: string | null; + /** + * Required. The display name of the attribute. + */ + displayName?: string | null; + /** + * Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory. + */ + mandatory?: boolean | null; + /** + * Identifier. The name of the attribute in the API Hub. Format: `projects/{project\}/locations/{location\}/attributes/{attribute\}` + */ + name?: string | null; + /** + * Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked. + */ + scope?: string | null; + /** + * Output only. The time at which the attribute was last updated. + */ + updateTime?: string | null; + } + /** + * The attribute values associated with resource. + */ + export interface Schema$GoogleCloudApihubV1AttributeValues { + /** + * Output only. The name of the attribute. Format: projects/{project\}/locations/{location\}/attributes/{attribute\} + */ + attribute?: string | null; + /** + * The attribute values associated with a resource in case attribute data type is enum. + */ + enumValues?: Schema$GoogleCloudApihubV1EnumAttributeValues; + /** + * The attribute values associated with a resource in case attribute data type is JSON. + */ + jsonValues?: Schema$GoogleCloudApihubV1StringAttributeValues; + /** + * The attribute values associated with a resource in case attribute data type is string. + */ + stringValues?: Schema$GoogleCloudApihubV1StringAttributeValues; + /** + * The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. + */ + uriValues?: Schema$GoogleCloudApihubV1StringAttributeValues; + } + /** + * AuthConfig represents the authentication information. + */ + export interface Schema$GoogleCloudApihubV1AuthConfig { + /** + * Api Key Config. + */ + apiKeyConfig?: Schema$GoogleCloudApihubV1ApiKeyConfig; + /** + * Required. The authentication type. + */ + authType?: string | null; + /** + * Google Service Account. + */ + googleServiceAccountConfig?: Schema$GoogleCloudApihubV1GoogleServiceAccountConfig; + /** + * Oauth2.0 Client Credentials. + */ + oauth2ClientCredentialsConfig?: Schema$GoogleCloudApihubV1Oauth2ClientCredentialsConfig; + /** + * User Password. + */ + userPasswordConfig?: Schema$GoogleCloudApihubV1UserPasswordConfig; + } + /** + * AuthConfigTemplate represents the authentication template for a plugin. + */ + export interface Schema$GoogleCloudApihubV1AuthConfigTemplate { + /** + * Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account. + */ + serviceAccount?: Schema$GoogleCloudApihubV1GoogleServiceAccountConfig; + /** + * Required. The list of authentication types supported by the plugin. + */ + supportedAuthTypes?: string[] | null; + } + /** + * The CollectApiData method's request. + */ + export interface Schema$GoogleCloudApihubV1CollectApiDataRequest { + /** + * Required. The action ID to be used for collecting the API data. This should map to one of the action IDs specified in action configs in the plugin. + */ + actionId?: string | null; + /** + * Required. The API data to be collected. + */ + apiData?: Schema$GoogleCloudApihubV1ApiData; + /** + * Required. The type of collection. Applies to all entries in api_data. + */ + collectionType?: string | null; + /** + * Required. The plugin instance collecting the API data. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}`. + */ + pluginInstance?: string | null; + } + /** + * Available configurations to provision an ApiHub Instance. + */ + export interface Schema$GoogleCloudApihubV1Config { + /** + * Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance. + */ + cmekKeyName?: string | null; + /** + * Optional. If true, the search will be disabled for the instance. The default value is false. + */ + disableSearch?: boolean | null; + /** + * Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used. + */ + encryptionType?: string | null; + /** + * Optional. The name of the Vertex AI location where the data store is stored. + */ + vertexLocation?: string | null; + } + /** + * ConfigTemplate represents the configuration template for a plugin. + */ + export interface Schema$GoogleCloudApihubV1ConfigTemplate { + /** + * Optional. The list of additional configuration variables for the plugin's configuration. + */ + additionalConfigTemplate?: Schema$GoogleCloudApihubV1ConfigVariableTemplate[]; + /** + * Optional. The authentication template for the plugin. + */ + authConfigTemplate?: Schema$GoogleCloudApihubV1AuthConfigTemplate; + } + /** + * ConfigValueOption represents an option for a config variable of type enum or multi select. + */ + export interface Schema$GoogleCloudApihubV1ConfigValueOption { + /** + * Optional. Description of the option. + */ + description?: string | null; + /** + * Required. Display name of the option. + */ + displayName?: string | null; + /** + * Required. Id of the option. + */ + id?: string | null; + } + /** + * ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate. + */ + export interface Schema$GoogleCloudApihubV1ConfigVariable { + /** + * Optional. The config variable value in case of config variable of type boolean. + */ + boolValue?: boolean | null; + /** + * Optional. The config variable value in case of config variable of type enum. + */ + enumValue?: Schema$GoogleCloudApihubV1ConfigValueOption; + /** + * Optional. The config variable value in case of config variable of type integer. + */ + intValue?: string | null; + /** + * Output only. Key will be the id to uniquely identify the config variable. + */ + key?: string | null; + /** + * Optional. The config variable value in case of config variable of type multi integer. + */ + multiIntValues?: Schema$GoogleCloudApihubV1MultiIntValues; + /** + * Optional. The config variable value in case of config variable of type multi select. + */ + multiSelectValues?: Schema$GoogleCloudApihubV1MultiSelectValues; + /** + * Optional. The config variable value in case of config variable of type multi string. + */ + multiStringValues?: Schema$GoogleCloudApihubV1MultiStringValues; + /** + * Optional. The config variable value in case of config variable of type secret. + */ + secretValue?: Schema$GoogleCloudApihubV1Secret; + /** + * Optional. The config variable value in case of config variable of type string. + */ + stringValue?: string | null; + } + /** + * ConfigVariableTemplate represents a configuration variable template present in a Plugin Config. + */ + export interface Schema$GoogleCloudApihubV1ConfigVariableTemplate { + /** + * Optional. Description. + */ + description?: string | null; + /** + * Optional. Enum options. To be populated if `ValueType` is `ENUM`. + */ + enumOptions?: Schema$GoogleCloudApihubV1ConfigValueOption[]; + /** + * Required. ID of the config variable. Must be unique within the configuration. + */ + id?: string | null; + /** + * Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT`. + */ + multiSelectOptions?: Schema$GoogleCloudApihubV1ConfigValueOption[]; + /** + * Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance. + */ + required?: boolean | null; + /** + * Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + */ + validationRegex?: string | null; + /** + * Required. Type of the parameter: string, int, bool etc. + */ + valueType?: string | null; + } + /** + * A curation resource in the API Hub. + */ + export interface Schema$GoogleCloudApihubV1Curation { + /** + * Output only. The time at which the curation was created. + */ + createTime?: string | null; + /** + * Optional. The description of the curation. + */ + description?: string | null; + /** + * Required. The display name of the curation. + */ + displayName?: string | null; + /** + * Required. The endpoint to be triggered for curation. + */ + endpoint?: Schema$GoogleCloudApihubV1Endpoint; + /** + * Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. + */ + lastExecutionErrorCode?: string | null; + /** + * Output only. Error message describing the failure, if any, during the last execution of the curation. + */ + lastExecutionErrorMessage?: string | null; + /** + * Output only. The last execution state of the curation. + */ + lastExecutionState?: string | null; + /** + * Identifier. The name of the curation. Format: `projects/{project\}/locations/{location\}/curations/{curation\}` + */ + name?: string | null; + /** + * Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. + */ + pluginInstanceActions?: Schema$GoogleCloudApihubV1PluginInstanceActionID[]; + /** + * Output only. The time at which the curation was last updated. + */ + updateTime?: string | null; + } + /** + * The curation information for this plugin instance. + */ + export interface Schema$GoogleCloudApihubV1CurationConfig { + /** + * Required. The curation type for this plugin instance. + */ + curationType?: string | null; + /** + * Optional. Custom curation information for this plugin instance. + */ + customCuration?: Schema$GoogleCloudApihubV1CustomCuration; + } + /** + * Custom curation information for this plugin instance. + */ + export interface Schema$GoogleCloudApihubV1CustomCuration { + /** + * Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project\}/locations/{location\}/curations/{curation\}` + */ + curation?: string | null; + } + /** + * Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only `schema` object is supported. + */ + export interface Schema$GoogleCloudApihubV1Definition { + /** + * Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource. + */ + attributes?: { + [key: string]: Schema$GoogleCloudApihubV1AttributeValues; + } | null; + /** + * Output only. The time at which the definition was created. + */ + createTime?: string | null; + /** + * Identifier. The name of the definition. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/definitions/{definition\}` + */ + name?: string | null; + /** + * Output only. The value of a schema definition. + */ + schema?: Schema$GoogleCloudApihubV1Schema; + /** + * Output only. The name of the spec from where the definition was parsed. Format is `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` + */ + spec?: string | null; + /** + * Output only. The type of the definition. + */ + type?: string | null; + /** + * Output only. The time at which the definition was last updated. + */ + updateTime?: string | null; + } + /** + * A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API. + */ + export interface Schema$GoogleCloudApihubV1Dependency { + /** + * Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource. + */ + attributes?: { + [key: string]: Schema$GoogleCloudApihubV1AttributeValues; + } | null; + /** + * Required. Immutable. The entity acting as the consumer in the dependency. + */ + consumer?: Schema$GoogleCloudApihubV1DependencyEntityReference; + /** + * Output only. The time at which the dependency was created. + */ + createTime?: string | null; + /** + * Optional. Human readable description corresponding of the dependency. + */ + description?: string | null; + /** + * Output only. Discovery mode of the dependency. + */ + discoveryMode?: string | null; + /** + * Output only. Error details of a dependency if the system has detected it internally. + */ + errorDetail?: Schema$GoogleCloudApihubV1DependencyErrorDetail; + /** + * Identifier. The name of the dependency in the API Hub. Format: `projects/{project\}/locations/{location\}/dependencies/{dependency\}` + */ + name?: string | null; + /** + * Output only. State of the dependency. + */ + state?: string | null; + /** + * Required. Immutable. The entity acting as the supplier in the dependency. + */ + supplier?: Schema$GoogleCloudApihubV1DependencyEntityReference; + /** + * Output only. The time at which the dependency was last updated. + */ + updateTime?: string | null; + } + /** + * Reference to an entity participating in a dependency. + */ + export interface Schema$GoogleCloudApihubV1DependencyEntityReference { + /** + * Output only. Display name of the entity. + */ + displayName?: string | null; + /** + * The resource name of an external API in the API Hub. Format: `projects/{project\}/locations/{location\}/externalApis/{external_api\}` + */ + externalApiResourceName?: string | null; + /** + * The resource name of an operation in the API Hub. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/operations/{operation\}` + */ + operationResourceName?: string | null; + } + /** + * Details describing error condition of a dependency. + */ + export interface Schema$GoogleCloudApihubV1DependencyErrorDetail { + /** + * Optional. Error in the dependency. + */ + error?: string | null; + /** + * Optional. Timestamp at which the error was found. + */ + errorTime?: string | null; + } + /** + * Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. + */ + export interface Schema$GoogleCloudApihubV1Deployment { + /** + * Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). + */ + apiVersions?: string[] | null; + /** + * Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource. + */ + attributes?: { + [key: string]: Schema$GoogleCloudApihubV1AttributeValues; + } | null; + /** + * Output only. The time at which the deployment was created. + */ + createTime?: string | null; + /** + * Required. The type of deployment. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + deploymentType?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Optional. The description of the deployment. + */ + description?: string | null; + /** + * Required. The display name of the deployment. + */ + displayName?: string | null; + /** + * Optional. The documentation of the deployment. + */ + documentation?: Schema$GoogleCloudApihubV1Documentation; + /** + * Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses. + */ + endpoints?: string[] | null; + /** + * Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + environment?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Identifier. The name of the deployment. Format: `projects/{project\}/locations/{location\}/deployments/{deployment\}` + */ + name?: string | null; + /** + * Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy. + */ + resourceUri?: string | null; + /** + * Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + slo?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Output only. The list of sources and metadata from the sources of the deployment. + */ + sourceMetadata?: Schema$GoogleCloudApihubV1SourceMetadata[]; + /** + * Output only. The time at which the deployment was last updated. + */ + updateTime?: string | null; + } + /** + * The metadata associated with a deployment. + */ + export interface Schema$GoogleCloudApihubV1DeploymentMetadata { + /** + * Required. The deployment resource to be pushed to Hub's collect layer. The ID of the deployment will be generated by Hub. + */ + deployment?: Schema$GoogleCloudApihubV1Deployment; + /** + * Optional. Timestamp indicating when the deployment was created at the source. + */ + originalCreateTime?: string | null; + /** + * Optional. The unique identifier of the deployment in the system where it was originally created. + */ + originalId?: string | null; + /** + * Required. Timestamp indicating when the deployment was last updated at the source. + */ + originalUpdateTime?: string | null; + } + /** + * The DisablePluginInstanceAction method's request. + */ + export interface Schema$GoogleCloudApihubV1DisablePluginInstanceActionRequest { + /** + * Required. The action id to disable. + */ + actionId?: string | null; + } + /** + * The DisablePlugin method's request. + */ + export interface Schema$GoogleCloudApihubV1DisablePluginRequest {} + /** + * Documentation details. + */ + export interface Schema$GoogleCloudApihubV1Documentation { + /** + * Optional. The uri of the externally hosted documentation. + */ + externalUri?: string | null; + } + /** + * The EnablePluginInstanceAction method's request. + */ + export interface Schema$GoogleCloudApihubV1EnablePluginInstanceActionRequest { + /** + * Required. The action id to enable. + */ + actionId?: string | null; + } + /** + * The EnablePlugin method's request. + */ + export interface Schema$GoogleCloudApihubV1EnablePluginRequest {} + /** + * The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. + */ + export interface Schema$GoogleCloudApihubV1Endpoint { + /** + * Required. The details of the Application Integration endpoint to be triggered for curation. + */ + applicationIntegrationEndpointDetails?: Schema$GoogleCloudApihubV1ApplicationIntegrationEndpointDetails; + } + /** + * The attribute values of data type enum. + */ + export interface Schema$GoogleCloudApihubV1EnumAttributeValues { + /** + * Required. The attribute values in case attribute data type is enum. + */ + values?: Schema$GoogleCloudApihubV1AllowedValue[]; + } + /** + * The ExecutePluginInstanceAction method's request. + */ + export interface Schema$GoogleCloudApihubV1ExecutePluginInstanceActionRequest { + /** + * Required. The execution details for the action to execute. + */ + actionExecutionDetail?: Schema$GoogleCloudApihubV1ActionExecutionDetail; + } + /** + * The execution status for the plugin instance. + */ + export interface Schema$GoogleCloudApihubV1ExecutionStatus { + /** + * Output only. The current state of the execution. + */ + currentExecutionState?: string | null; + /** + * Output only. The last execution of the plugin instance. + */ + lastExecution?: Schema$GoogleCloudApihubV1LastExecution; + } + /** + * An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies. + */ + export interface Schema$GoogleCloudApihubV1ExternalApi { + /** + * Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource. + */ + attributes?: { + [key: string]: Schema$GoogleCloudApihubV1AttributeValues; + } | null; + /** + * Output only. Creation timestamp. + */ + createTime?: string | null; + /** + * Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points). + */ + description?: string | null; + /** + * Required. Display name of the external API. Max length is 63 characters (Unicode Code Points). + */ + displayName?: string | null; + /** + * Optional. Documentation of the external API. + */ + documentation?: Schema$GoogleCloudApihubV1Documentation; + /** + * Optional. List of endpoints on which this API is accessible. + */ + endpoints?: string[] | null; + /** + * Identifier. Format: `projects/{project\}/locations/{location\}/externalApi/{externalApi\}`. + */ + name?: string | null; + /** + * Optional. List of paths served by this API. + */ + paths?: string[] | null; + /** + * Output only. Last update timestamp. + */ + updateTime?: string | null; + } + /** + * Config for Google service account authentication. + */ + export interface Schema$GoogleCloudApihubV1GoogleServiceAccountConfig { + /** + * Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account. + */ + serviceAccount?: string | null; + } + /** + * The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality. + */ + export interface Schema$GoogleCloudApihubV1HostingService { + /** + * Optional. The URI of the service implemented by the plugin developer, used to invoke the plugin's functionality. This information is only required for user defined plugins. + */ + serviceUri?: string | null; + } + /** + * Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub. + */ + export interface Schema$GoogleCloudApihubV1HostProjectRegistration { + /** + * Output only. The time at which the host project registration was created. + */ + createTime?: string | null; + /** + * Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number. + */ + gcpProject?: string | null; + /** + * Identifier. The name of the host project registration. Format: "projects/{project\}/locations/{location\}/hostProjectRegistrations/{host_project_registration\}". + */ + name?: string | null; + } + /** + * The HTTP Operation. + */ + export interface Schema$GoogleCloudApihubV1HttpOperation { + /** + * Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. + */ + method?: string | null; + /** + * Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. + */ + path?: Schema$GoogleCloudApihubV1Path; + } + /** + * Issue contains the details of a single issue found by the linter. + */ + export interface Schema$GoogleCloudApihubV1Issue { + /** + * Required. Rule code unique to each rule defined in linter. + */ + code?: string | null; + /** + * Required. Human-readable message describing the issue found by the linter. + */ + message?: string | null; + /** + * Required. An array of strings indicating the location in the analyzed document where the rule was triggered. + */ + path?: string[] | null; + /** + * Required. Object describing where in the file the issue was found. + */ + range?: Schema$GoogleCloudApihubV1Range; + /** + * Required. Severity level of the rule violation. + */ + severity?: string | null; + } + /** + * The result of the last execution of the plugin instance. + */ + export interface Schema$GoogleCloudApihubV1LastExecution { + /** + * Output only. The last execution end time of the plugin instance. + */ + endTime?: string | null; + /** + * Output only. Error message describing the failure, if any, during the last execution. + */ + errorMessage?: string | null; + /** + * Output only. The result of the last execution of the plugin instance. + */ + result?: string | null; + /** + * Output only. The last execution start time of the plugin instance. + */ + startTime?: string | null; + } + /** + * LintResponse contains the response from the linter. + */ + export interface Schema$GoogleCloudApihubV1LintResponse { + /** + * Required. Timestamp when the linting response was generated. + */ + createTime?: string | null; + /** + * Optional. Array of issues found in the analyzed document. + */ + issues?: Schema$GoogleCloudApihubV1Issue[]; + /** + * Required. Name of the linter used. + */ + linter?: string | null; + /** + * Required. Name of the linting application. + */ + source?: string | null; + /** + * Required. Lint state represents success or failure for linting. + */ + state?: string | null; + /** + * Optional. Summary of all issue types and counts for each severity level. + */ + summary?: Schema$GoogleCloudApihubV1SummaryEntry[]; + } + /** + * The LintSpec method's request. + */ + export interface Schema$GoogleCloudApihubV1LintSpecRequest {} + /** + * The ListApiOperations method's response. + */ + export interface Schema$GoogleCloudApihubV1ListApiOperationsResponse { + /** + * The operations corresponding to an API version. + */ + apiOperations?: Schema$GoogleCloudApihubV1ApiOperation[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The ListApis method's response. + */ + export interface Schema$GoogleCloudApihubV1ListApisResponse { + /** + * The API resources present in the API hub. + */ + apis?: Schema$GoogleCloudApihubV1Api[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The ListAttributes method's response. + */ + export interface Schema$GoogleCloudApihubV1ListAttributesResponse { + /** + * The list of all attributes. + */ + attributes?: Schema$GoogleCloudApihubV1Attribute[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The ListCurations method's response. + */ + export interface Schema$GoogleCloudApihubV1ListCurationsResponse { + /** + * The curation resources present in the API hub. + */ + curations?: Schema$GoogleCloudApihubV1Curation[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The ListDependencies method's response. + */ + export interface Schema$GoogleCloudApihubV1ListDependenciesResponse { + /** + * The dependency resources present in the API hub. + */ + dependencies?: Schema$GoogleCloudApihubV1Dependency[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The ListDeployments method's response. + */ + export interface Schema$GoogleCloudApihubV1ListDeploymentsResponse { + /** + * The deployment resources present in the API hub. + */ + deployments?: Schema$GoogleCloudApihubV1Deployment[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The ListExternalApis method's response. + */ + export interface Schema$GoogleCloudApihubV1ListExternalApisResponse { + /** + * The External API resources present in the API hub. + */ + externalApis?: Schema$GoogleCloudApihubV1ExternalApi[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The ListHostProjectRegistrations method's response. + */ + export interface Schema$GoogleCloudApihubV1ListHostProjectRegistrationsResponse { + /** + * The list of host project registrations. + */ + hostProjectRegistrations?: Schema$GoogleCloudApihubV1HostProjectRegistration[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The ListPluginInstances method's response. + */ + export interface Schema$GoogleCloudApihubV1ListPluginInstancesResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The plugin instances from the specified parent resource. + */ + pluginInstances?: Schema$GoogleCloudApihubV1PluginInstance[]; + } + /** + * The ListPlugins method's response. + */ + export interface Schema$GoogleCloudApihubV1ListPluginsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The plugins from the specified parent resource. + */ + plugins?: Schema$GoogleCloudApihubV1Plugin[]; + } + /** + * The ListRuntimeProjectAttachments method's response. + */ + export interface Schema$GoogleCloudApihubV1ListRuntimeProjectAttachmentsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * List of runtime project attachments. + */ + runtimeProjectAttachments?: Schema$GoogleCloudApihubV1RuntimeProjectAttachment[]; + } + /** + * The ListSpecs method's response. + */ + export interface Schema$GoogleCloudApihubV1ListSpecsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The specs corresponding to an API Version. + */ + specs?: Schema$GoogleCloudApihubV1Spec[]; + } + /** + * The ListVersions method's response. + */ + export interface Schema$GoogleCloudApihubV1ListVersionsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The versions corresponding to an API. + */ + versions?: Schema$GoogleCloudApihubV1Version[]; + } + /** + * The LookupApiHubInstance method's response.` + */ + export interface Schema$GoogleCloudApihubV1LookupApiHubInstanceResponse { + /** + * API Hub instance for a project if it exists, empty otherwise. + */ + apiHubInstance?: Schema$GoogleCloudApihubV1ApiHubInstance; + } + /** + * The ListRuntimeProjectAttachments method's response. + */ + export interface Schema$GoogleCloudApihubV1LookupRuntimeProjectAttachmentResponse { + /** + * Runtime project attachment for a project if exists, empty otherwise. + */ + runtimeProjectAttachment?: Schema$GoogleCloudApihubV1RuntimeProjectAttachment; + } + /** + * The config variable value of data type multi int. + */ + export interface Schema$GoogleCloudApihubV1MultiIntValues { + /** + * Optional. The config variable value of data type multi int. + */ + values?: number[] | null; + } + /** + * The config variable value of data type multi select. + */ + export interface Schema$GoogleCloudApihubV1MultiSelectValues { + /** + * Optional. The config variable value of data type multi select. + */ + values?: Schema$GoogleCloudApihubV1ConfigValueOption[]; + } + /** + * The config variable value of data type multi string. + */ + export interface Schema$GoogleCloudApihubV1MultiStringValues { + /** + * Optional. The config variable value of data type multi string. + */ + values?: string[] | null; + } + /** + * Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. + */ + export interface Schema$GoogleCloudApihubV1Oauth2ClientCredentialsConfig { + /** + * Required. The client identifier. + */ + clientId?: string | null; + /** + * Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret. + */ + clientSecret?: Schema$GoogleCloudApihubV1Secret; + } + /** + * OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. + */ + export interface Schema$GoogleCloudApihubV1OpenApiSpecDetails { + /** + * Output only. The format of the spec. + */ + format?: string | null; + /** + * Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec. + */ + owner?: Schema$GoogleCloudApihubV1Owner; + /** + * Output only. The version in the spec. This maps to `info.version` in OpenAPI spec. + */ + version?: string | null; + } + /** + * The operation details parsed from the spec. + */ + export interface Schema$GoogleCloudApihubV1OperationDetails { + /** + * Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec. + */ + deprecated?: boolean | null; + /** + * Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used. + */ + description?: string | null; + /** + * Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec. + */ + documentation?: Schema$GoogleCloudApihubV1Documentation; + /** + * The HTTP Operation. + */ + httpOperation?: Schema$GoogleCloudApihubV1HttpOperation; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudApihubV1OperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * Owner details. + */ + export interface Schema$GoogleCloudApihubV1Owner { + /** + * Optional. The name of the owner. + */ + displayName?: string | null; + /** + * Required. The email of the owner. + */ + email?: string | null; + } + /** + * The path details derived from the spec. + */ + export interface Schema$GoogleCloudApihubV1Path { + /** + * Optional. A short description for the path applicable to all operations. + */ + description?: string | null; + /** + * Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided. + */ + path?: string | null; + } + /** + * A plugin resource in the API Hub. + */ + export interface Schema$GoogleCloudApihubV1Plugin { + /** + * Optional. The configuration of actions supported by the plugin. + */ + actionsConfig?: Schema$GoogleCloudApihubV1PluginActionConfig[]; + /** + * Optional. The configuration template for the plugin. + */ + configTemplate?: Schema$GoogleCloudApihubV1ConfigTemplate; + /** + * Output only. Timestamp indicating when the plugin was created. + */ + createTime?: string | null; + /** + * Optional. The plugin description. Max length is 2000 characters (Unicode code points). + */ + description?: string | null; + /** + * Required. The display name of the plugin. Max length is 50 characters (Unicode code points). + */ + displayName?: string | null; + /** + * Optional. The documentation of the plugin, that explains how to set up and use the plugin. + */ + documentation?: Schema$GoogleCloudApihubV1Documentation; + /** + * Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI. + */ + hostingService?: Schema$GoogleCloudApihubV1HostingService; + /** + * Identifier. The name of the plugin. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}` + */ + name?: string | null; + /** + * Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'. + */ + ownershipType?: string | null; + /** + * Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins. + */ + pluginCategory?: string | null; + /** + * Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level. + */ + state?: string | null; + /** + * Optional. The type of the API. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-plugin-type` attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. Note this field is not required for plugins developed via plugin framework. + */ + type?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Output only. Timestamp indicating when the plugin was last updated. + */ + updateTime?: string | null; + } + /** + * PluginActionConfig represents the configuration of an action supported by a plugin. + */ + export interface Schema$GoogleCloudApihubV1PluginActionConfig { + /** + * Required. The description of the operation performed by the action. + */ + description?: string | null; + /** + * Required. The display name of the action. + */ + displayName?: string | null; + /** + * Required. The id of the action. + */ + id?: string | null; + /** + * Required. The trigger mode supported by the action. + */ + triggerMode?: string | null; + } + /** + * Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details. + */ + export interface Schema$GoogleCloudApihubV1PluginInstance { + /** + * Required. The action status for the plugin instance. + */ + actions?: Schema$GoogleCloudApihubV1PluginInstanceAction[]; + /** + * Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable. + */ + additionalConfig?: { + [key: string]: Schema$GoogleCloudApihubV1ConfigVariable; + } | null; + /** + * Optional. The authentication information for this plugin instance. + */ + authConfig?: Schema$GoogleCloudApihubV1AuthConfig; + /** + * Output only. Timestamp indicating when the plugin instance was created. + */ + createTime?: string | null; + /** + * Required. The display name for this plugin instance. Max length is 255 characters. + */ + displayName?: string | null; + /** + * Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state. + */ + errorMessage?: string | null; + /** + * Identifier. The unique name of the plugin instance resource. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}` + */ + name?: string | null; + /** + * Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning). + */ + state?: string | null; + /** + * Output only. Timestamp indicating when the plugin instance was last updated. + */ + updateTime?: string | null; + } + /** + * PluginInstanceAction represents an action which can be executed in the plugin instance. + */ + export interface Schema$GoogleCloudApihubV1PluginInstanceAction { + /** + * Required. This should map to one of the action id specified in actions_config in the plugin. + */ + actionId?: string | null; + /** + * Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer. + */ + curationConfig?: Schema$GoogleCloudApihubV1CurationConfig; + /** + * Optional. The execution information for the plugin instance action done corresponding to an API hub instance. + */ + hubInstanceAction?: Schema$GoogleCloudApihubV1ExecutionStatus; + /** + * Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action. + */ + scheduleCronExpression?: string | null; + /** + * Optional. The time zone for the schedule cron expression. If not provided, UTC will be used. + */ + scheduleTimeZone?: string | null; + /** + * Output only. The current state of the plugin action in the plugin instance. + */ + state?: string | null; + } + /** + * The plugin instance and associated action that is using the curation. + */ + export interface Schema$GoogleCloudApihubV1PluginInstanceActionID { + /** + * Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin. + */ + actionId?: string | null; + /** + * Output only. Plugin instance that is using the curation. Format is `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}` + */ + pluginInstance?: string | null; + } + /** + * PluginInstanceActionSource represents the plugin instance action source. + */ + export interface Schema$GoogleCloudApihubV1PluginInstanceActionSource { + /** + * Output only. The id of the plugin instance action. + */ + actionId?: string | null; + /** + * Output only. The resource name of the source plugin instance. Format is `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}` + */ + pluginInstance?: string | null; + } + /** + * Point within the file (line and character). + */ + export interface Schema$GoogleCloudApihubV1Point { + /** + * Required. Character position within the line (zero-indexed). + */ + character?: number | null; + /** + * Required. Line number (zero-indexed). + */ + line?: number | null; + } + /** + * Object describing where in the file the issue was found. + */ + export interface Schema$GoogleCloudApihubV1Range { + /** + * Required. End of the issue. + */ + end?: Schema$GoogleCloudApihubV1Point; + /** + * Required. Start of the issue. + */ + start?: Schema$GoogleCloudApihubV1Point; + } + /** + * Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments. + */ + export interface Schema$GoogleCloudApihubV1RuntimeProjectAttachment { + /** + * Output only. Create time. + */ + createTime?: string | null; + /** + * Identifier. The resource name of a runtime project attachment. Format: "projects/{project\}/locations/{location\}/runtimeProjectAttachments/{runtime_project_attachment\}". + */ + name?: string | null; + /** + * Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number. + */ + runtimeProject?: string | null; + } + /** + * The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the `definitions` section for OpenAPI 2.0 version and in `components.schemas` section for OpenAPI 3.0 and 3.1 version. + */ + export interface Schema$GoogleCloudApihubV1Schema { + /** + * Output only. The display name of the schema. This will map to the name of the schema in the spec. + */ + displayName?: string | null; + /** + * Output only. The raw value of the schema definition corresponding to the schema name in the spec. + */ + rawValue?: string | null; + } + /** + * The SearchResources method's request. + */ + export interface Schema$GoogleCloudApihubV1SearchResourcesRequest { + /** + * Optional. An expression that filters the list of search results. 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 `=`. Filters are not case sensitive. The following field names are eligible for filtering: * `resource_type` - The type of resource in the search results. Must be one of the following: `Api`, `ApiOperation`, `Deployment`, `Definition`, `Spec` or `Version`. This field can only be specified once in the filter. Here are is an example: * `resource_type = Api` - The resource_type is _Api_. + */ + filter?: string | null; + /** + * Optional. The maximum number of search results to return. The service may return fewer than this value. If unspecified at most 10 search results will be returned. If value is negative then `INVALID_ARGUMENT` error is returned. The maximum value is 25; values above 25 will be coerced to 25. While paginating, you can specify a new page size parameter for each page of search results to be listed. + */ + pageSize?: number | null; + /** + * Optional. A page token, received from a previous SearchResources call. Specify this parameter to retrieve the next page of transactions. When paginating, you must specify the `page_token` parameter and all the other parameters except page_size should be specified with the same value which was used in the previous call. If the other fields are set with a different value than the previous call then `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string | null; + /** + * Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc. + */ + query?: string | null; + } + /** + * Response for the SearchResources method. + */ + export interface Schema$GoogleCloudApihubV1SearchResourcesResponse { + /** + * Pass this token in the SearchResourcesRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response. + */ + nextPageToken?: string | null; + /** + * List of search results according to the filter and search query specified. The order of search results represents the ranking. + */ + searchResults?: Schema$GoogleCloudApihubV1SearchResult[]; + } + /** + * Represents the search results. + */ + export interface Schema$GoogleCloudApihubV1SearchResult { + /** + * This represents the ApiHubResource. Note: Only selected fields of the resources are populated in response. + */ + resource?: Schema$GoogleCloudApihubV1ApiHubResource; + } + /** + * Secret provides a reference to entries in Secret Manager. + */ + export interface Schema$GoogleCloudApihubV1Secret { + /** + * Required. The resource name of the secret version in the format, format as: `projects/x/secrets/x/versions/x`. + */ + secretVersion?: string | null; + } + /** + * SourceMetadata represents the metadata for a resource at the source. + */ + export interface Schema$GoogleCloudApihubV1SourceMetadata { + /** + * Output only. The time at which the resource was created at the source. + */ + originalResourceCreateTime?: string | null; + /** + * Output only. The unique identifier of the resource at the source. + */ + originalResourceId?: string | null; + /** + * Output only. The time at which the resource was last updated at the source. + */ + originalResourceUpdateTime?: string | null; + /** + * Output only. The source of the resource is a plugin instance action. + */ + pluginInstanceActionSource?: Schema$GoogleCloudApihubV1PluginInstanceActionSource; + /** + * Output only. The type of the source. + */ + sourceType?: string | null; + } + /** + * Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. + */ + export interface Schema$GoogleCloudApihubV1Spec { + /** + * Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource. + */ + attributes?: { + [key: string]: Schema$GoogleCloudApihubV1AttributeValues; + } | null; + /** + * Optional. Input only. The contents of the uploaded spec. + */ + contents?: Schema$GoogleCloudApihubV1SpecContents; + /** + * Output only. The time at which the spec was created. + */ + createTime?: string | null; + /** + * Output only. Details parsed from the spec. + */ + details?: Schema$GoogleCloudApihubV1SpecDetails; + /** + * Required. The display name of the spec. This can contain the file name of the spec. + */ + displayName?: string | null; + /** + * Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec. + */ + documentation?: Schema$GoogleCloudApihubV1Documentation; + /** + * Optional. The lint response for the spec. + */ + lintResponse?: Schema$GoogleCloudApihubV1LintResponse; + /** + * Identifier. The name of the spec. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` + */ + name?: string | null; + /** + * Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. + */ + parsingMode?: string | null; + /** + * Output only. The list of sources and metadata from the sources of the spec. + */ + sourceMetadata?: Schema$GoogleCloudApihubV1SourceMetadata[]; + /** + * Optional. The URI of the spec source in case file is uploaded from an external version control system. + */ + sourceUri?: string | null; + /** + * Required. The type of spec. The value should be one of the allowed values defined for `projects/{project\}/locations/{location\}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided. + */ + specType?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Output only. The time at which the spec was last updated. + */ + updateTime?: string | null; + } + /** + * The spec contents. + */ + export interface Schema$GoogleCloudApihubV1SpecContents { + /** + * Required. The contents of the spec. + */ + contents?: string | null; + /** + * Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. + */ + mimeType?: string | null; + } + /** + * SpecDetails contains the details parsed from supported spec types. + */ + export interface Schema$GoogleCloudApihubV1SpecDetails { + /** + * Output only. The description of the spec. + */ + description?: string | null; + /** + * Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method. + */ + openApiSpecDetails?: Schema$GoogleCloudApihubV1OpenApiSpecDetails; + } + /** + * The metadata associated with a spec of the API version. + */ + export interface Schema$GoogleCloudApihubV1SpecMetadata { + /** + * Optional. Timestamp indicating when the spec was created at the source. + */ + originalCreateTime?: string | null; + /** + * Optional. The unique identifier of the spec in the system where it was originally created. + */ + originalId?: string | null; + /** + * Required. Timestamp indicating when the spec was last updated at the source. + */ + originalUpdateTime?: string | null; + /** + * Required. The spec resource to be pushed to Hub's collect layer. The ID of the spec will be generated by Hub. + */ + spec?: Schema$GoogleCloudApihubV1Spec; + } + /** + * The attribute values of data type string or JSON. + */ + export interface Schema$GoogleCloudApihubV1StringAttributeValues { + /** + * Required. The attribute values in case attribute data type is string or JSON. + */ + values?: string[] | null; + } + /** + * Represents a singleton style guide resource to be used for linting Open API specs. + */ + export interface Schema$GoogleCloudApihubV1StyleGuide { + /** + * Required. Input only. The contents of the uploaded style guide. + */ + contents?: Schema$GoogleCloudApihubV1StyleGuideContents; + /** + * Required. Target linter for the style guide. + */ + linter?: string | null; + /** + * Identifier. The name of the style guide. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/styleGuide` + */ + name?: string | null; + } + /** + * The style guide contents. + */ + export interface Schema$GoogleCloudApihubV1StyleGuideContents { + /** + * Required. The contents of the style guide. + */ + contents?: string | null; + /** + * Required. The mime type of the content. + */ + mimeType?: string | null; + } + /** + * Count of issues with a given severity. + */ + export interface Schema$GoogleCloudApihubV1SummaryEntry { + /** + * Required. Count of issues with the given severity. + */ + count?: number | null; + /** + * Required. Severity of the issue. + */ + severity?: string | null; + } + /** + * Parameters to support Username and Password Authentication. + */ + export interface Schema$GoogleCloudApihubV1UserPasswordConfig { + /** + * Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret. + */ + password?: Schema$GoogleCloudApihubV1Secret; + /** + * Required. Username. + */ + username?: string | null; + } + /** + * Represents a version of the API resource in API hub. This is also referred to as the API version. + */ + export interface Schema$GoogleCloudApihubV1Version { + /** + * Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + accreditation?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/operations/{operation\}` + */ + apiOperations?: string[] | null; + /** + * Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project\}/locations/{location\}/attributes/{attribute\}`. The value is the attribute values associated with the resource. + */ + attributes?: { + [key: string]: Schema$GoogleCloudApihubV1AttributeValues; + } | null; + /** + * Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + compliance?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Output only. The time at which the version was created. + */ + createTime?: string | null; + /** + * Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/definitions/{definition\}` + */ + definitions?: string[] | null; + /** + * Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project\}/locations/{location\}/deployments/{deployment\}` + */ + deployments?: string[] | null; + /** + * Optional. The description of the version. + */ + description?: string | null; + /** + * Required. The display name of the version. + */ + displayName?: string | null; + /** + * Optional. The documentation of the version. + */ + documentation?: Schema$GoogleCloudApihubV1Documentation; + /** + * Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. + */ + lifecycle?: Schema$GoogleCloudApihubV1AttributeValues; + /** + * Identifier. The name of the version. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + name?: string | null; + /** + * Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project\}/locations/{location\}/deployments/{deployment\}` + */ + selectedDeployment?: string | null; + /** + * Output only. The list of sources and metadata from the sources of the version. + */ + sourceMetadata?: Schema$GoogleCloudApihubV1SourceMetadata[]; + /** + * Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` + */ + specs?: string[] | null; + /** + * Output only. The time at which the version was last updated. + */ + updateTime?: string | null; + } + /** + * The metadata associated with a version of the API resource. + */ + export interface Schema$GoogleCloudApihubV1VersionMetadata { + /** + * Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc.) + */ + deployments?: Schema$GoogleCloudApihubV1DeploymentMetadata[]; + /** + * Optional. Timestamp indicating when the version was created at the source. + */ + originalCreateTime?: string | null; + /** + * Optional. The unique identifier of the version in the system where it was originally created. + */ + originalId?: string | null; + /** + * Required. Timestamp indicating when the version was last updated at the source. + */ + originalUpdateTime?: string | null; + /** + * Optional. The specs associated with this version. Note that an API version can be associated with multiple specs. + */ + specs?: Schema$GoogleCloudApihubV1SpecMetadata[]; + /** + * Required. Represents a version of the API resource in API hub. The ID of the version will be generated by Hub. + */ + version?: Schema$GoogleCloudApihubV1Version; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudCommonOperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + */ + cancelRequested?: boolean | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusDetail?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$GoogleCloudLocationListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$GoogleCloudLocationLocation[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$GoogleCloudLocationLocation { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$GoogleLongrunningCancelOperationRequest {} + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$GoogleLongrunningListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$GoogleLongrunningOperation[]; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$GoogleLongrunningOperation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$GoogleRpcStatus; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`. + */ + name?: string | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$GoogleRpcStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + apiHubInstances: Resource$Projects$Locations$Apihubinstances; + apis: Resource$Projects$Locations$Apis; + attributes: Resource$Projects$Locations$Attributes; + curations: Resource$Projects$Locations$Curations; + dependencies: Resource$Projects$Locations$Dependencies; + deployments: Resource$Projects$Locations$Deployments; + externalApis: Resource$Projects$Locations$Externalapis; + hostProjectRegistrations: Resource$Projects$Locations$Hostprojectregistrations; + operations: Resource$Projects$Locations$Operations; + plugins: Resource$Projects$Locations$Plugins; + runtimeProjectAttachments: Resource$Projects$Locations$Runtimeprojectattachments; + constructor(context: APIRequestContext) { + this.context = context; + this.apiHubInstances = new Resource$Projects$Locations$Apihubinstances( + this.context + ); + this.apis = new Resource$Projects$Locations$Apis(this.context); + this.attributes = new Resource$Projects$Locations$Attributes( + this.context + ); + this.curations = new Resource$Projects$Locations$Curations(this.context); + this.dependencies = new Resource$Projects$Locations$Dependencies( + this.context + ); + this.deployments = new Resource$Projects$Locations$Deployments( + this.context + ); + this.externalApis = new Resource$Projects$Locations$Externalapis( + this.context + ); + this.hostProjectRegistrations = + new Resource$Projects$Locations$Hostprojectregistrations(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.plugins = new Resource$Projects$Locations$Plugins(this.context); + this.runtimeProjectAttachments = + new Resource$Projects$Locations$Runtimeprojectattachments(this.context); + } + + /** + * Collect API data from a source and push it to Hub's collect layer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + collectApiData( + params: Params$Resource$Projects$Locations$Collectapidata, + options: StreamMethodOptions + ): GaxiosPromise; + collectApiData( + params?: Params$Resource$Projects$Locations$Collectapidata, + options?: MethodOptions + ): GaxiosPromise; + collectApiData( + params: Params$Resource$Projects$Locations$Collectapidata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + collectApiData( + params: Params$Resource$Projects$Locations$Collectapidata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + collectApiData( + params: Params$Resource$Projects$Locations$Collectapidata, + callback: BodyResponseCallback + ): void; + collectApiData( + callback: BodyResponseCallback + ): void; + collectApiData( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collectapidata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collectapidata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Collectapidata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+location}:collectApiData').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about 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. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Look up a runtime project attachment. This API can be called in the context of any 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. + */ + lookupRuntimeProjectAttachment( + params: Params$Resource$Projects$Locations$Lookupruntimeprojectattachment, + options: StreamMethodOptions + ): GaxiosPromise; + lookupRuntimeProjectAttachment( + params?: Params$Resource$Projects$Locations$Lookupruntimeprojectattachment, + options?: MethodOptions + ): GaxiosPromise; + lookupRuntimeProjectAttachment( + params: Params$Resource$Projects$Locations$Lookupruntimeprojectattachment, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupRuntimeProjectAttachment( + params: Params$Resource$Projects$Locations$Lookupruntimeprojectattachment, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupRuntimeProjectAttachment( + params: Params$Resource$Projects$Locations$Lookupruntimeprojectattachment, + callback: BodyResponseCallback + ): void; + lookupRuntimeProjectAttachment( + callback: BodyResponseCallback + ): void; + lookupRuntimeProjectAttachment( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lookupruntimeprojectattachment + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lookupruntimeprojectattachment; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lookupruntimeprojectattachment; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+name}:lookupRuntimeProjectAttachment' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Search across API-Hub resources. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchResources( + params: Params$Resource$Projects$Locations$Searchresources, + options: StreamMethodOptions + ): GaxiosPromise; + searchResources( + params?: Params$Resource$Projects$Locations$Searchresources, + options?: MethodOptions + ): GaxiosPromise; + searchResources( + params: Params$Resource$Projects$Locations$Searchresources, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchResources( + params: Params$Resource$Projects$Locations$Searchresources, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchResources( + params: Params$Resource$Projects$Locations$Searchresources, + callback: BodyResponseCallback + ): void; + searchResources( + callback: BodyResponseCallback + ): void; + searchResources( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Searchresources + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Searchresources; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Searchresources; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+location}:searchResources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collectapidata + extends StandardParameters { + /** + * Required. The regional location of the API hub instance and its resources. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1CollectApiDataRequest; + } + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Lookupruntimeprojectattachment + extends StandardParameters { + /** + * Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: `projects/{project\}/locations/{location\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Searchresources + extends StandardParameters { + /** + * Required. The resource name of the location which will be of the type `projects/{project_id\}/locations/{location_id\}`. This field is used to identify the instance of API-Hub in which resources should be searched. + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1SearchResourcesRequest; + } + + export class Resource$Projects$Locations$Apihubinstances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Provisions instance resources for the API Hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apihubinstances$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Apihubinstances$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Apihubinstances$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apihubinstances$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apihubinstances$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apihubinstances$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apihubinstances$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apihubinstances$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/apiHubInstances').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the API hub 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. + */ + delete( + params: Params$Resource$Projects$Locations$Apihubinstances$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Apihubinstances$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Apihubinstances$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apihubinstances$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apihubinstances$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apihubinstances$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apihubinstances$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apihubinstances$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single API Hub 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. + */ + get( + params: Params$Resource$Projects$Locations$Apihubinstances$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Apihubinstances$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Apihubinstances$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apihubinstances$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apihubinstances$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apihubinstances$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apihubinstances$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apihubinstances$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookup( + params: Params$Resource$Projects$Locations$Apihubinstances$Lookup, + options: StreamMethodOptions + ): GaxiosPromise; + lookup( + params?: Params$Resource$Projects$Locations$Apihubinstances$Lookup, + options?: MethodOptions + ): GaxiosPromise; + lookup( + params: Params$Resource$Projects$Locations$Apihubinstances$Lookup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Apihubinstances$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Projects$Locations$Apihubinstances$Lookup, + callback: BodyResponseCallback + ): void; + lookup( + callback: BodyResponseCallback + ): void; + lookup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apihubinstances$Lookup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apihubinstances$Lookup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apihubinstances$Lookup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/apiHubInstances:lookup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Apihubinstances$Create + extends StandardParameters { + /** + * Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are `/a-z[0-9]-_/`. + */ + apiHubInstanceId?: string; + /** + * Required. The parent resource for the Api Hub instance resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1ApiHubInstance; + } + export interface Params$Resource$Projects$Locations$Apihubinstances$Delete + extends StandardParameters { + /** + * Required. The name of the Api Hub instance to delete. Format: `projects/{project\}/locations/{location\}/apiHubInstances/{apiHubInstance\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apihubinstances$Get + extends StandardParameters { + /** + * Required. The name of the Api Hub instance to retrieve. Format: `projects/{project\}/locations/{location\}/apiHubInstances/{apiHubInstance\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apihubinstances$Lookup + extends StandardParameters { + /** + * Required. There will always be only one Api Hub instance for a GCP project across all locations. The parent resource for the Api Hub instance resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Apis { + context: APIRequestContext; + versions: Resource$Projects$Locations$Apis$Versions; + constructor(context: APIRequestContext) { + this.context = context; + this.versions = new Resource$Projects$Locations$Apis$Versions( + this.context + ); + } + + /** + * Create an API resource in the API hub. Once an API resource is created, versions can be added to it. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Apis$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Apis$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apis$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apis$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/apis').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete an API resource in the API hub. API can only be deleted if all underlying versions are 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. + */ + delete( + params: Params$Resource$Projects$Locations$Apis$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Apis$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Apis$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apis$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apis$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get API resource details including the API versions contained in it. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Apis$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Apis$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List API resources in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Apis$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Apis$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Apis$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Apis$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/apis').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Apis$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Apis$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Apis$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Apis$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Apis$Create + extends StandardParameters { + /** + * Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. + */ + apiId?: string; + /** + * Required. The parent resource for the API resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Api; + } + export interface Params$Resource$Projects$Locations$Apis$Delete + extends StandardParameters { + /** + * Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions. + */ + force?: boolean; + /** + * Required. The name of the API resource to delete. Format: `projects/{project\}/locations/{location\}/apis/{api\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Get + extends StandardParameters { + /** + * Required. The name of the API resource to retrieve. Format: `projects/{project\}/locations/{location\}/apis/{api\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apis$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of ApiResources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `\>`, `:` or `=`. Filters are not case sensitive. The following fields in the `ApiResource` are eligible for filtering: * `owner.email` - The email of the team which owns the ApiResource. Allowed comparison operators: `=`. * `create_time` - The time at which the ApiResource was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `\>` and `<`. * `display_name` - The display name of the ApiResource. Allowed comparison operators: `=`. * `target_user.enum_values.values.id` - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `target_user.enum_values.values.display_name` - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.id` - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.display_name` - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.id` - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.display_name` - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.id` - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.display_name` - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.id` - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.display_name` - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `owner.email = \"apihub@google.com\"` - - The owner team email is _apihub@google.com_. * `owner.email = \"apihub@google.com\" AND create_time < \"2021-08-15T14:50:00Z\" AND create_time \> \"2021-08-10T12:00:00Z\"` - The owner team email is _apihub@google.com_ and the api was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `owner.email = \"apihub@google.com\" OR team.enum_values.values.id: apihub-team-id` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is _apihub-team-id_. * `owner.email = \"apihub@google.com\" OR team.enum_values.values.display_name: ApiHub Team` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is `ApiHub Team`. * `owner.email = \"apihub@google.com\" AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test_enum_id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/1765\0f90-4a29-5431-b3d0-d5532da3764c.string_values.values: test_string_value` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ and the id of the allowed value associated with the user defined attribute of type enum is _test_enum_id_ and the value of the user defined attribute of type string is _test_.. + */ + filter?: string; + /** + * Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListApis` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of API resources. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Patch + extends StandardParameters { + /** + * Identifier. The name of the API resource in the API Hub. Format: `projects/{project\}/locations/{location\}/apis/{api\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Api; + } + + export class Resource$Projects$Locations$Apis$Versions { + context: APIRequestContext; + definitions: Resource$Projects$Locations$Apis$Versions$Definitions; + operations: Resource$Projects$Locations$Apis$Versions$Operations; + specs: Resource$Projects$Locations$Apis$Versions$Specs; + constructor(context: APIRequestContext) { + this.context = context; + this.definitions = + new Resource$Projects$Locations$Apis$Versions$Definitions(this.context); + this.operations = + new Resource$Projects$Locations$Apis$Versions$Operations(this.context); + this.specs = new Resource$Projects$Locations$Apis$Versions$Specs( + this.context + ); + } + + /** + * Create an API version for an API resource in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Apis$Versions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Apis$Versions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apis$Versions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apis$Versions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$Versions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are 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. + */ + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Apis$Versions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$Versions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Apis$Versions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$Versions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List API versions of an API resource in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Apis$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Apis$Versions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Apis$Versions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Apis$Versions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update API version. The following fields in the version can be updated currently: * display_name * description * documentation * deployments * lifecycle * compliance * accreditation * attributes The update_mask should be used to specify the fields being updated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Apis$Versions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Apis$Versions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Apis$Versions$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Apis$Versions$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Apis$Versions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Apis$Versions$Create + extends StandardParameters { + /** + * Required. The parent resource for API version. Format: `projects/{project\}/locations/{location\}/apis/{api\}` + */ + parent?: string; + /** + * Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another version in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}`, its length is limited to 700 characters and valid characters are /a-z[0-9]-_/. + */ + versionId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Version; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Delete + extends StandardParameters { + /** + * Optional. If set to true, any specs from this version will also be deleted. Otherwise, the request will only work if the version has no specs. + */ + force?: boolean; + /** + * Required. The name of the version to delete. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Get + extends StandardParameters { + /** + * Required. The name of the API version to retrieve. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of Versions. 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 `=`. Filters are not case sensitive. The following fields in the `Version` are eligible for filtering: * `display_name` - The display name of the Version. Allowed comparison operators: `=`. * `create_time` - The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `\>` and `<`. * `lifecycle.enum_values.values.id` - The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`. * `lifecycle.enum_values.values.display_name` - The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`. * `compliance.enum_values.values.id` - The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators: `:`. * `compliance.enum_values.values.display_name` - The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators: `:`. * `accreditation.enum_values.values.id` - The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. * `accreditation.enum_values.values.display_name` - The allowed value display name of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `lifecycle.enum_values.values.id: preview-id` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_. * `lifecycle.enum_values.values.display_name: \"Preview Display Name\"` - The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version is `Preview Display Name`. * `lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time \> \"2021-08-10T12:00:00Z\"` - The id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_ and it was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id` - The id of the allowed value associated with the compliance attribute is _gdpr-id_ or _pci-dss-id_. * `lifecycle.enum_values.values.id: preview-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_ and the value of the user defined attribute of type string is _test_. + */ + filter?: string; + /** + * Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListVersions` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent which owns this collection of API versions i.e., the API resource Format: `projects/{project\}/locations/{location\}/apis/{api\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Patch + extends StandardParameters { + /** + * Identifier. The name of the version. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Version; + } + + export class Resource$Projects$Locations$Apis$Versions$Definitions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get details about a definition in an API version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Definitions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Apis$Versions$Definitions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Definitions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Definitions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Definitions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Definitions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Definitions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Definitions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Apis$Versions$Definitions$Get + extends StandardParameters { + /** + * Required. The name of the definition to retrieve. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/definitions/{definition\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Apis$Versions$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create an apiOperation in an API version. An apiOperation can be created only if the version has no apiOperations which were created by parsing a spec. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Operations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Apis$Versions$Operations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Operations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Operations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Operations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Delete an operation in an API version and we can delete only the operations created via create API. If the operation was created by parsing the spec, then it can be deleted by editing or deleting the spec. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Apis$Versions$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get details about a particular operation in API version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Apis$Versions$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List operations in an API version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Apis$Versions$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Operations$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Apis$Versions$Operations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Apis$Versions$Operations$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Operations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Operations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Operations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Apis$Versions$Operations$Create + extends StandardParameters { + /** + * Optional. The ID to use for the operation resource, which will become the final component of the operation's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another operation resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/operations/{operation\}`, its length is limited to 700 characters, and valid characters are /a-z[0-9]-_/. + */ + apiOperationId?: string; + /** + * Required. The parent resource for the operation resource. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1ApiOperation; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Operations$Delete + extends StandardParameters { + /** + * Required. The name of the operation resource to delete. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/operations/{operation\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Operations$Get + extends StandardParameters { + /** + * Required. The name of the operation to retrieve. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/operations/{operation\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Operations$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of ApiOperations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: `<`, `\>` or `=`. Filters are not case sensitive. The following fields in the `ApiOperation` are eligible for filtering: * `name` - The ApiOperation resource name. Allowed comparison operators: `=`. * `details.http_operation.path.path` - The http operation's complete path relative to server endpoint. Allowed comparison operators: `=`. * `details.http_operation.method` - The http operation method type. Allowed comparison operators: `=`. * `details.deprecated` - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: `=`. * `create_time` - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `\>` and `<`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `details.deprecated = True` - The ApiOperation is deprecated. * `details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time \> \"2021-08-10T12:00:00Z\"` - The method of the http operation of the ApiOperation is _GET_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `details.http_operation.method = GET OR details.http_operation.method = POST`. - The http operation of the method of ApiOperation is _GET_ or _POST_. * `details.deprecated = True AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the ApiOperation is deprecated and the value of the user defined attribute of type string is _test_. + */ + filter?: string; + /** + * Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListApiOperations` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent which owns this collection of operations i.e., the API version. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Operations$Patch + extends StandardParameters { + /** + * Identifier. The name of the operation. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/operations/{operation\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1ApiOperation; + } + + export class Resource$Projects$Locations$Apis$Versions$Specs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the `projects/{project\}/locations/{location\}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Specs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Specs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/specs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete a spec. Deleting a spec will also delete the associated operations from the version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Specs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Specs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Specs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get spec contents. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getContents( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents, + options: StreamMethodOptions + ): GaxiosPromise; + getContents( + params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents, + options?: MethodOptions + ): GaxiosPromise; + getContents( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getContents( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getContents( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents, + callback: BodyResponseCallback + ): void; + getContents( + callback: BodyResponseCallback + ): void; + getContents( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:contents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core 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. + */ + lint( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Lint, + options: StreamMethodOptions + ): GaxiosPromise; + lint( + params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Lint, + options?: MethodOptions + ): GaxiosPromise; + lint( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Lint, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lint( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Lint, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lint( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Lint, + callback: BodyResponseCallback + ): void; + lint(callback: BodyResponseCallback): void; + lint( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Specs$Lint + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Lint; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Lint; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:lint').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List specs corresponding to a particular API 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$Apis$Versions$Specs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Specs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/specs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The update_mask should be used to specify the fields being updated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apis$Versions$Specs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Create + extends StandardParameters { + /** + * Required. The parent resource for Spec. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + parent?: string; + /** + * Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another spec in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/. + */ + specId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Spec; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete + extends StandardParameters { + /** + * Required. The name of the spec to delete. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Get + extends StandardParameters { + /** + * Required. The name of the spec to retrieve. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents + extends StandardParameters { + /** + * Required. The name of the spec whose contents need to be retrieved. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Lint + extends StandardParameters { + /** + * Required. The name of the spec to be linted. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1LintSpecRequest; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `\>`, `:` or `=`. Filters are not case sensitive. The following fields in the `Spec` are eligible for filtering: * `display_name` - The display name of the Spec. Allowed comparison operators: `=`. * `create_time` - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `\>` and `<`. * `spec_type.enum_values.values.id` - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `spec_type.enum_values.values.display_name` - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `lint_response.json_values.values` - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: `:`. * `mime_type` - The MIME type of the Spec. Allowed comparison operators: `=`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `spec_type.enum_values.values.id: rest-id` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_. * `spec_type.enum_values.values.display_name: \"Rest Display Name\"` - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is `Rest Display Name`. * `spec_type.enum_values.values.id: grpc-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time \> \"2021-08-10T12:00:00Z\"` - The id of the allowed value associated with the spec_type attribute is _grpc-id_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `spec_type.enum_values.values.id: rest-id OR spec_type.enum_values.values.id: grpc-id` - The id of the allowed value associated with the spec_type attribute is _rest-id_ or _grpc-id_. * `spec_type.enum_values.values.id: rest-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_ and the id of the allowed value associated with the user defined attribute of type enum is _test_. + */ + filter?: string; + /** + * Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSpecs` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of specs. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch + extends StandardParameters { + /** + * Identifier. The name of the spec. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Spec; + } + + export class Resource$Projects$Locations$Attributes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as `SYSTEM_DEFINED` and can be listed via ListAttributes method. Allowed values for the same can be updated via UpdateAttribute method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Attributes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Attributes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Attributes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Attributes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Attributes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Attributes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Attributes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Attributes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/attributes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get 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. + */ + delete( + params: Params$Resource$Projects$Locations$Attributes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Attributes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Attributes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Attributes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Attributes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Attributes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Attributes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Attributes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get details about the attribute. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Attributes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Attributes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Attributes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Attributes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Attributes$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Attributes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Attributes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Attributes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List all attributes. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Attributes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Attributes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Attributes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Attributes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Attributes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Attributes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Attributes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Attributes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/attributes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update the attribute. The following fields in the Attribute resource can be updated: * display_name The display name can be updated for user defined attributes only. * description The description can be updated for user defined attributes only. * allowed_values To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted. * cardinality The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update. The update_mask should be used to specify the fields being updated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Attributes$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Attributes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Attributes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Attributes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Attributes$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Attributes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Attributes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Attributes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Attributes$Create + extends StandardParameters { + /** + * Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another attribute resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. + */ + attributeId?: string; + /** + * Required. The parent resource for Attribute. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Attribute; + } + export interface Params$Resource$Projects$Locations$Attributes$Delete + extends StandardParameters { + /** + * Required. The name of the attribute to delete. Format: `projects/{project\}/locations/{location\}/attributes/{attribute\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Attributes$Get + extends StandardParameters { + /** + * Required. The name of the attribute to retrieve. Format: `projects/{project\}/locations/{location\}/attributes/{attribute\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Attributes$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of Attributes. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: `<`, `\>` or `=`. Filters are not case sensitive. The following fields in the `Attribute` are eligible for filtering: * `display_name` - The display name of the Attribute. Allowed comparison operators: `=`. * `definition_type` - The definition type of the attribute. Allowed comparison operators: `=`. * `scope` - The scope of the attribute. Allowed comparison operators: `=`. * `data_type` - The type of the data of the attribute. Allowed comparison operators: `=`. * `mandatory` - Denotes whether the attribute is mandatory or not. Allowed comparison operators: `=`. * `create_time` - The time at which the Attribute was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `\>` and `<`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `display_name = production` - - The display name of the attribute is _production_. * `(display_name = production) AND (create_time < \"2021-08-15T14:50:00Z\") AND (create_time \> \"2021-08-10T12:00:00Z\")` - The display name of the attribute is _production_ and the attribute was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `display_name = production OR scope = api` - The attribute where the display name is _production_ or the scope is _api_. + */ + filter?: string; + /** + * Optional. The maximum number of attribute resources to return. The service may return fewer than this value. If unspecified, at most 50 attributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAttributes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAttributes` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent resource for Attribute. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Attributes$Patch + extends StandardParameters { + /** + * Identifier. The name of the attribute in the API Hub. Format: `projects/{project\}/locations/{location\}/attributes/{attribute\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Attribute; + } + + export class Resource$Projects$Locations$Curations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Curations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Curations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Curations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Curations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Curations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Curations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Curations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Curations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/curations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin 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. + */ + delete( + params: Params$Resource$Projects$Locations$Curations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Curations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Curations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Curations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Curations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Curations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Curations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Curations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get curation resource details. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Curations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Curations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Curations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Curations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Curations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Curations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Curations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Curations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List curation resources in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Curations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Curations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Curations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Curations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Curations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Curations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Curations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Curations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/curations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update a curation resource in the API hub. The following fields in the curation can be updated: * display_name * description The update_mask should be used to specify the fields being updated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Curations$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Curations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Curations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Curations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Curations$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Curations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Curations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Curations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Curations$Create + extends StandardParameters { + /** + * Optional. The ID to use for the curation resource, which will become the final component of the curations's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub. * If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. + */ + curationId?: string; + /** + * Required. The parent resource for the curation resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Curation; + } + export interface Params$Resource$Projects$Locations$Curations$Delete + extends StandardParameters { + /** + * Required. The name of the curation resource to delete. Format: `projects/{project\}/locations/{location\}/curations/{curation\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Curations$Get + extends StandardParameters { + /** + * Required. The name of the curation resource to retrieve. Format: `projects/{project\}/locations/{location\}/curations/{curation\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Curations$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of curation resources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `\>`, `:` or `=`. Filters are case insensitive. The following fields in the `curation resource` are eligible for filtering: * `create_time` - The time at which the curation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `\>` and `<`. * `display_name` - The display name of the curation. Allowed comparison operators: `=`. * `state` - The state of the curation. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `create_time < \"2021-08-15T14:50:00Z\" AND create_time \> \"2021-08-10T12:00:00Z\"` - The curation resource was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. + */ + filter?: string; + /** + * Optional. The maximum number of curation resources to return. The service may return fewer than this value. If unspecified, at most 50 curations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListCurations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListCurations` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of curation resources. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Curations$Patch + extends StandardParameters { + /** + * Identifier. The name of the curation. Format: `projects/{project\}/locations/{location\}/curations/{curation\}` + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Curation; + } + + export class Resource$Projects$Locations$Dependencies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a dependency between two entities in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Dependencies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Dependencies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Dependencies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Dependencies$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Dependencies$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Dependencies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Dependencies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Dependencies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dependencies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Delete the dependency 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$Dependencies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Dependencies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Dependencies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Dependencies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Dependencies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Dependencies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Dependencies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Dependencies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get details about a dependency resource in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Dependencies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Dependencies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Dependencies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Dependencies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Dependencies$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Dependencies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Dependencies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Dependencies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List dependencies based on the provided filter and pagination parameters. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Dependencies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Dependencies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Dependencies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Dependencies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Dependencies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Dependencies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Dependencies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Dependencies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dependencies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update a dependency based on the update_mask provided in the request. The following fields in the dependency can be updated: * description + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Dependencies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Dependencies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Dependencies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Dependencies$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Dependencies$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Dependencies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Dependencies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Dependencies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Dependencies$Create + extends StandardParameters { + /** + * Optional. The ID to use for the dependency resource, which will become the final component of the dependency's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if duplicate id is provided by the client. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are `a-z[0-9]-_`. + */ + dependencyId?: string; + /** + * Required. The parent resource for the dependency resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Dependency; + } + export interface Params$Resource$Projects$Locations$Dependencies$Delete + extends StandardParameters { + /** + * Required. The name of the dependency resource to delete. Format: `projects/{project\}/locations/{location\}/dependencies/{dependency\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Dependencies$Get + extends StandardParameters { + /** + * Required. The name of the dependency resource to retrieve. Format: `projects/{project\}/locations/{location\}/dependencies/{dependency\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Dependencies$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of Dependencies. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. Allowed comparison operator is `=`. Filters are not case sensitive. The following fields in the `Dependency` are eligible for filtering: * `consumer.operation_resource_name` - The operation resource name for the consumer entity involved in a dependency. Allowed comparison operators: `=`. * `consumer.external_api_resource_name` - The external api resource name for the consumer entity involved in a dependency. Allowed comparison operators: `=`. * `supplier.operation_resource_name` - The operation resource name for the supplier entity involved in a dependency. Allowed comparison operators: `=`. * `supplier.external_api_resource_name` - The external api resource name for the supplier entity involved in a dependency. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. For example, `consumer.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR supplier.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\"` - The dependencies with either consumer or supplier operation resource name as _projects/p1/locations/global/apis/a1/versions/v1/operations/o1_. + */ + filter?: string; + /** + * Optional. The maximum number of dependency resources to return. The service may return fewer than this value. If unspecified, at most 50 dependencies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListDependencies` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDependencies` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent which owns this collection of dependency resources. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Dependencies$Patch + extends StandardParameters { + /** + * Identifier. The name of the dependency in the API Hub. Format: `projects/{project\}/locations/{location\}/dependencies/{dependency\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Dependency; + } + + export class Resource$Projects$Locations$Deployments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Deployments$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Deployments$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Deployments$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Deployments$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Deployments$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deployments$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deployments$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deployments$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/deployments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Delete a deployment resource in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Deployments$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Deployments$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Deployments$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Deployments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Deployments$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deployments$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deployments$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deployments$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get details about a deployment and the API versions linked to it. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Deployments$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Deployments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Deployments$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Deployments$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Deployments$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deployments$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deployments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deployments$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List deployment resources in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Deployments$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Deployments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Deployments$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Deployments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Deployments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deployments$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deployments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deployments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/deployments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update a deployment resource in the API hub. The following fields in the deployment resource can be updated: * display_name * description * documentation * deployment_type * resource_uri * endpoints * slo * environment * attributes The update_mask should be used to specify the fields being updated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Deployments$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Deployments$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Deployments$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deployments$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deployments$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deployments$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deployments$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deployments$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Deployments$Create + extends StandardParameters { + /** + * Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another deployment resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. + */ + deploymentId?: string; + /** + * Required. The parent resource for the deployment resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Deployment; + } + export interface Params$Resource$Projects$Locations$Deployments$Delete + extends StandardParameters { + /** + * Required. The name of the deployment resource to delete. Format: `projects/{project\}/locations/{location\}/deployments/{deployment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Deployments$Get + extends StandardParameters { + /** + * Required. The name of the deployment resource to retrieve. Format: `projects/{project\}/locations/{location\}/deployments/{deployment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Deployments$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of Deployments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `\>` or `=`. Filters are not case sensitive. The following fields in the `Deployments` are eligible for filtering: * `display_name` - The display name of the Deployment. Allowed comparison operators: `=`. * `create_time` - The time at which the Deployment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `\>` and `<`. * `resource_uri` - A URI to the deployment resource. Allowed comparison operators: `=`. * `api_versions` - The API versions linked to this deployment. Allowed comparison operators: `:`. * `deployment_type.enum_values.values.id` - The allowed value id of the deployment_type attribute associated with the Deployment. Allowed comparison operators: `:`. * `deployment_type.enum_values.values.display_name` - The allowed value display name of the deployment_type attribute associated with the Deployment. Allowed comparison operators: `:`. * `slo.string_values.values` -The allowed string value of the slo attribute associated with the deployment. Allowed comparison operators: `:`. * `environment.enum_values.values.id` - The allowed value id of the environment attribute associated with the deployment. Allowed comparison operators: `:`. * `environment.enum_values.values.display_name` - The allowed value display name of the environment attribute associated with the deployment. Allowed comparison operators: `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `environment.enum_values.values.id: staging-id` - The allowed value id of the environment attribute associated with the Deployment is _staging-id_. * `environment.enum_values.values.display_name: \"Staging Deployment\"` - The allowed value display name of the environment attribute associated with the Deployment is `Staging Deployment`. * `environment.enum_values.values.id: production-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time \> \"2021-08-10T12:00:00Z\"` - The allowed value id of the environment attribute associated with the Deployment is _production-id_ and Deployment was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `environment.enum_values.values.id: production-id OR slo.string_values.values: \"99.99%\"` - The allowed value id of the environment attribute Deployment is _production-id_ or string value of the slo attribute is _99.99%_. * `environment.enum_values.values.id: staging-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the allowed value id of the environment attribute associated with the Deployment is _staging-id_ and the value of the user defined attribute of type string is _test_. + */ + filter?: string; + /** + * Optional. The maximum number of deployment resources to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListDeployments` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of deployment resources. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Deployments$Patch + extends StandardParameters { + /** + * Identifier. The name of the deployment. Format: `projects/{project\}/locations/{location\}/deployments/{deployment\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Deployment; + } + + export class Resource$Projects$Locations$Externalapis { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create an External API resource in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Externalapis$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Externalapis$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Externalapis$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Externalapis$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Externalapis$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Externalapis$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Externalapis$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Externalapis$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/externalApis').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Delete an External API resource in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Externalapis$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Externalapis$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Externalapis$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Externalapis$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Externalapis$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Externalapis$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Externalapis$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Externalapis$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get details about an External API resource in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Externalapis$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Externalapis$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Externalapis$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Externalapis$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Externalapis$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Externalapis$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Externalapis$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Externalapis$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List External API resources in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Externalapis$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Externalapis$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Externalapis$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Externalapis$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Externalapis$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Externalapis$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Externalapis$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Externalapis$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/externalApis').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update an External API resource in the API hub. The following fields can be updated: * display_name * description * documentation * endpoints * paths The update_mask should be used to specify the fields being updated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Externalapis$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Externalapis$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Externalapis$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Externalapis$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Externalapis$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Externalapis$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Externalapis$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Externalapis$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Externalapis$Create + extends StandardParameters { + /** + * Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. + */ + externalApiId?: string; + /** + * Required. The parent resource for the External API resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1ExternalApi; + } + export interface Params$Resource$Projects$Locations$Externalapis$Delete + extends StandardParameters { + /** + * Required. The name of the External API resource to delete. Format: `projects/{project\}/locations/{location\}/externalApis/{externalApi\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Externalapis$Get + extends StandardParameters { + /** + * Required. The name of the External API resource to retrieve. Format: `projects/{project\}/locations/{location\}/externalApis/{externalApi\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Externalapis$List + extends StandardParameters { + /** + * Optional. The maximum number of External API resources to return. The service may return fewer than this value. If unspecified, at most 50 ExternalApis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListExternalApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListExternalApis` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of External API resources. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Externalapis$Patch + extends StandardParameters { + /** + * Identifier. Format: `projects/{project\}/locations/{location\}/externalApi/{externalApi\}`. + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1ExternalApi; + } + + export class Resource$Projects$Locations$Hostprojectregistrations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Hostprojectregistrations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Hostprojectregistrations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Hostprojectregistrations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Hostprojectregistrations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Hostprojectregistrations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hostprojectregistrations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hostprojectregistrations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hostprojectregistrations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/hostProjectRegistrations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Get a host project registration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Hostprojectregistrations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Hostprojectregistrations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Hostprojectregistrations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Hostprojectregistrations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Hostprojectregistrations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hostprojectregistrations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hostprojectregistrations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hostprojectregistrations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists host project registrations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Hostprojectregistrations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Hostprojectregistrations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Hostprojectregistrations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Hostprojectregistrations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Hostprojectregistrations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hostprojectregistrations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hostprojectregistrations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hostprojectregistrations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/hostProjectRegistrations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Hostprojectregistrations$Create + extends StandardParameters { + /** + * Required. The ID to use for the Host Project Registration, which will become the final component of the host project registration's resource name. The ID must be the same as the Google cloud project specified in the host_project_registration.gcp_project field. + */ + hostProjectRegistrationId?: string; + /** + * Required. The parent resource for the host project. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1HostProjectRegistration; + } + export interface Params$Resource$Projects$Locations$Hostprojectregistrations$Get + extends StandardParameters { + /** + * Required. Host project registration resource name. projects/{project\}/locations/{location\}/hostProjectRegistrations/{host_project_registration_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hostprojectregistrations$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of HostProjectRegistrations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `HostProjectRegistration` are eligible for filtering: * `name` - The name of the HostProjectRegistration. * `create_time` - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * `gcp_project` - The Google cloud project associated with the HostProjectRegistration. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. The maximum number of host project registrations to return. The service may return fewer than this value. If unspecified, at most 50 host project registrations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListHostProjectRegistrations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListHostProjectRegistrations` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of host projects. Format: `projects/x/locations/x` + */ + parent?: 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://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + 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 class Resource$Projects$Locations$Plugins { + context: APIRequestContext; + instances: Resource$Projects$Locations$Plugins$Instances; + styleGuide: Resource$Projects$Locations$Plugins$Styleguide; + constructor(context: APIRequestContext) { + this.context = context; + this.instances = new Resource$Projects$Locations$Plugins$Instances( + this.context + ); + this.styleGuide = new Resource$Projects$Locations$Plugins$Styleguide( + this.context + ); + } + + /** + * Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Plugins$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Plugins$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Plugins$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Plugins$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Plugins$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Plugins$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/plugins').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Plugins$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Plugins$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Plugins$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Plugins$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Plugins$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Plugins$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Disables a plugin. The `state` of the plugin after disabling is `DISABLED` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + disable( + params: Params$Resource$Projects$Locations$Plugins$Disable, + options: StreamMethodOptions + ): GaxiosPromise; + disable( + params?: Params$Resource$Projects$Locations$Plugins$Disable, + options?: MethodOptions + ): GaxiosPromise; + disable( + params: Params$Resource$Projects$Locations$Plugins$Disable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Plugins$Disable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Plugins$Disable, + callback: BodyResponseCallback + ): void; + disable( + callback: BodyResponseCallback + ): void; + disable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Disable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Disable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Plugins$Disable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:disable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Enables a plugin. The `state` of the plugin after enabling is `ENABLED` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + enable( + params: Params$Resource$Projects$Locations$Plugins$Enable, + options: StreamMethodOptions + ): GaxiosPromise; + enable( + params?: Params$Resource$Projects$Locations$Plugins$Enable, + options?: MethodOptions + ): GaxiosPromise; + enable( + params: Params$Resource$Projects$Locations$Plugins$Enable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Locations$Plugins$Enable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Locations$Plugins$Enable, + callback: BodyResponseCallback + ): void; + enable( + callback: BodyResponseCallback + ): void; + enable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Enable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Enable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Plugins$Enable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:enable').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get an API Hub plugin. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Plugins$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Plugins$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Plugins$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Plugins$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Plugins$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Plugins$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get the style guide being used for linting. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getStyleGuide( + params: Params$Resource$Projects$Locations$Plugins$Getstyleguide, + options: StreamMethodOptions + ): GaxiosPromise; + getStyleGuide( + params?: Params$Resource$Projects$Locations$Plugins$Getstyleguide, + options?: MethodOptions + ): GaxiosPromise; + getStyleGuide( + params: Params$Resource$Projects$Locations$Plugins$Getstyleguide, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getStyleGuide( + params: Params$Resource$Projects$Locations$Plugins$Getstyleguide, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getStyleGuide( + params: Params$Resource$Projects$Locations$Plugins$Getstyleguide, + callback: BodyResponseCallback + ): void; + getStyleGuide( + callback: BodyResponseCallback + ): void; + getStyleGuide( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Getstyleguide + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Getstyleguide; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Plugins$Getstyleguide; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List all the plugins in a given 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$Plugins$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Plugins$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Plugins$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Plugins$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Plugins$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Plugins$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/plugins').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update the styleGuide to be used for liniting in by API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateStyleGuide( + params: Params$Resource$Projects$Locations$Plugins$Updatestyleguide, + options: StreamMethodOptions + ): GaxiosPromise; + updateStyleGuide( + params?: Params$Resource$Projects$Locations$Plugins$Updatestyleguide, + options?: MethodOptions + ): GaxiosPromise; + updateStyleGuide( + params: Params$Resource$Projects$Locations$Plugins$Updatestyleguide, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateStyleGuide( + params: Params$Resource$Projects$Locations$Plugins$Updatestyleguide, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateStyleGuide( + params: Params$Resource$Projects$Locations$Plugins$Updatestyleguide, + callback: BodyResponseCallback + ): void; + updateStyleGuide( + callback: BodyResponseCallback + ): void; + updateStyleGuide( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Updatestyleguide + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Updatestyleguide; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Plugins$Updatestyleguide; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Plugins$Create + extends StandardParameters { + /** + * Required. The parent resource where this plugin will be created. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project\}/locations/{location\}/plugins/{plugin\}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/. + */ + pluginId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1Plugin; + } + export interface Params$Resource$Projects$Locations$Plugins$Delete + extends StandardParameters { + /** + * Required. The name of the Plugin resource to delete. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Plugins$Disable + extends StandardParameters { + /** + * Required. The name of the plugin to disable. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1DisablePluginRequest; + } + export interface Params$Resource$Projects$Locations$Plugins$Enable + extends StandardParameters { + /** + * Required. The name of the plugin to enable. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1EnablePluginRequest; + } + export interface Params$Resource$Projects$Locations$Plugins$Get + extends StandardParameters { + /** + * Required. The name of the plugin to retrieve. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Plugins$Getstyleguide + extends StandardParameters { + /** + * Required. The name of the spec to retrieve. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/styleGuide`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Plugins$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of plugins. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `\>` or `=`. Filters are not case sensitive. The following fields in the `Plugins` are eligible for filtering: * `plugin_category` - The category of the Plugin. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `plugin_category = ON_RAMP` - The plugin is of category on ramp. + */ + filter?: string; + /** + * Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListPlugins` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListPlugins` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent resource where this plugin will be created. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Plugins$Updatestyleguide + extends StandardParameters { + /** + * Identifier. The name of the style guide. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/styleGuide` + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1StyleGuide; + } + + export class Resource$Projects$Locations$Plugins$Instances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Plugin instance in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Plugins$Instances$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Plugins$Instances$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Plugins$Instances$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Plugins$Instances$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Plugins$Instances$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Instances$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Instances$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Plugins$Instances$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/instances').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a plugin instance in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Plugins$Instances$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Plugins$Instances$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Plugins$Instances$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Plugins$Instances$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Plugins$Instances$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Instances$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Instances$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Plugins$Instances$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Disables a plugin instance in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + disableAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Disableaction, + options: StreamMethodOptions + ): GaxiosPromise; + disableAction( + params?: Params$Resource$Projects$Locations$Plugins$Instances$Disableaction, + options?: MethodOptions + ): GaxiosPromise; + disableAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Disableaction, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disableAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Disableaction, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disableAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Disableaction, + callback: BodyResponseCallback + ): void; + disableAction( + callback: BodyResponseCallback + ): void; + disableAction( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Instances$Disableaction + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Instances$Disableaction; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Plugins$Instances$Disableaction; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:disableAction').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Enables a plugin instance in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + enableAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Enableaction, + options: StreamMethodOptions + ): GaxiosPromise; + enableAction( + params?: Params$Resource$Projects$Locations$Plugins$Instances$Enableaction, + options?: MethodOptions + ): GaxiosPromise; + enableAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Enableaction, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Enableaction, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enableAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Enableaction, + callback: BodyResponseCallback + ): void; + enableAction( + callback: BodyResponseCallback + ): void; + enableAction( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Instances$Enableaction + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Instances$Enableaction; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Plugins$Instances$Enableaction; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:enableAction').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Executes a plugin instance in the API hub. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + executeAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Executeaction, + options: StreamMethodOptions + ): GaxiosPromise; + executeAction( + params?: Params$Resource$Projects$Locations$Plugins$Instances$Executeaction, + options?: MethodOptions + ): GaxiosPromise; + executeAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Executeaction, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Executeaction, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + executeAction( + params: Params$Resource$Projects$Locations$Plugins$Instances$Executeaction, + callback: BodyResponseCallback + ): void; + executeAction( + callback: BodyResponseCallback + ): void; + executeAction( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Instances$Executeaction + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Instances$Executeaction; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Plugins$Instances$Executeaction; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:executeAction').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get an API Hub plugin 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. + */ + get( + params: Params$Resource$Projects$Locations$Plugins$Instances$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Plugins$Instances$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Plugins$Instances$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Plugins$Instances$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Plugins$Instances$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Instances$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Instances$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Plugins$Instances$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List all the plugins in a given project and location. `-` can be used as wildcard value for {plugin_id\} + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Plugins$Instances$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Plugins$Instances$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Plugins$Instances$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Plugins$Instances$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Plugins$Instances$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Instances$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Instances$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Plugins$Instances$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/instances').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Plugins$Instances$Create + extends StandardParameters { + /** + * Required. The parent of the plugin instance resource. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}` + */ + parent?: string; + /** + * Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another plugin instance in the plugin resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. + */ + pluginInstanceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1PluginInstance; + } + export interface Params$Resource$Projects$Locations$Plugins$Instances$Delete + extends StandardParameters { + /** + * Required. The name of the plugin instance to delete. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Plugins$Instances$Disableaction + extends StandardParameters { + /** + * Required. The name of the plugin instance to disable. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1DisablePluginInstanceActionRequest; + } + export interface Params$Resource$Projects$Locations$Plugins$Instances$Enableaction + extends StandardParameters { + /** + * Required. The name of the plugin instance to enable. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1EnablePluginInstanceActionRequest; + } + export interface Params$Resource$Projects$Locations$Plugins$Instances$Executeaction + extends StandardParameters { + /** + * Required. The name of the plugin instance to execute. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1ExecutePluginInstanceActionRequest; + } + export interface Params$Resource$Projects$Locations$Plugins$Instances$Get + extends StandardParameters { + /** + * Required. The name of the plugin instance to retrieve. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}/instances/{instance\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Plugins$Instances$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of plugin instances. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `\>` or `=`. Filters are not case sensitive. The following fields in the `PluginInstances` are eligible for filtering: * `state` - The state of the Plugin Instance. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `state = ENABLED` - The plugin instance is in enabled state. + */ + filter?: string; + /** + * Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListPluginInstances` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluginInstances` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent resource where this plugin will be created. Format: `projects/{project\}/locations/{location\}/plugins/{plugin\}`. To list plugin instances for multiple plugins, use the - character instead of the plugin ID. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Plugins$Styleguide { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get the contents of the style guide. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getContents( + params: Params$Resource$Projects$Locations$Plugins$Styleguide$Getcontents, + options: StreamMethodOptions + ): GaxiosPromise; + getContents( + params?: Params$Resource$Projects$Locations$Plugins$Styleguide$Getcontents, + options?: MethodOptions + ): GaxiosPromise; + getContents( + params: Params$Resource$Projects$Locations$Plugins$Styleguide$Getcontents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getContents( + params: Params$Resource$Projects$Locations$Plugins$Styleguide$Getcontents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getContents( + params: Params$Resource$Projects$Locations$Plugins$Styleguide$Getcontents, + callback: BodyResponseCallback + ): void; + getContents( + callback: BodyResponseCallback + ): void; + getContents( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Plugins$Styleguide$Getcontents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Plugins$Styleguide$Getcontents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Plugins$Styleguide$Getcontents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:contents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Plugins$Styleguide$Getcontents + extends StandardParameters { + /** + * Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is `projects/{project\}/locations/{location\}/plugins/{plugin\}/styleGuide`. + */ + name?: string; + } + + export class Resource$Projects$Locations$Runtimeprojectattachments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Attaches a runtime project to the host 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. + */ + create( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Runtimeprojectattachments$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Runtimeprojectattachments$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Runtimeprojectattachments$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Runtimeprojectattachments$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/runtimeProjectAttachments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host 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. + */ + delete( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Runtimeprojectattachments$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Runtimeprojectattachments$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Runtimeprojectattachments$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Runtimeprojectattachments$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a runtime project attachment. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Runtimeprojectattachments$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Runtimeprojectattachments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Runtimeprojectattachments$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Runtimeprojectattachments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Runtimeprojectattachments$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List runtime projects attached to the host 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$Locations$Runtimeprojectattachments$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Runtimeprojectattachments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Runtimeprojectattachments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Runtimeprojectattachments$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Runtimeprojectattachments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Runtimeprojectattachments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apihub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/runtimeProjectAttachments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Runtimeprojectattachments$Create + extends StandardParameters { + /** + * Required. The parent resource for the Runtime Project Attachment. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment's name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field. + */ + runtimeProjectAttachmentId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudApihubV1RuntimeProjectAttachment; + } + export interface Params$Resource$Projects$Locations$Runtimeprojectattachments$Delete + extends StandardParameters { + /** + * Required. The name of the Runtime Project Attachment to delete. Format: `projects/{project\}/locations/{location\}/runtimeProjectAttachments/{runtime_project_attachment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Runtimeprojectattachments$Get + extends StandardParameters { + /** + * Required. The name of the API resource to retrieve. Format: `projects/{project\}/locations/{location\}/runtimeProjectAttachments/{runtime_project_attachment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Runtimeprojectattachments$List + extends StandardParameters { + /** + * Optional. An expression that filters the list of RuntimeProjectAttachments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `RuntimeProjectAttachment` are eligible for filtering: * `name` - The name of the RuntimeProjectAttachment. * `create_time` - The time at which the RuntimeProjectAttachment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * `runtime_project` - The Google cloud project associated with the RuntimeProjectAttachment. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. The maximum number of runtime project attachments to return. The service may return fewer than this value. If unspecified, at most 50 runtime project attachments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListRuntimeProjectAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListRuntimeProjectAttachments` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of runtime project attachments. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } +} diff --git a/src/apis/apihub/webpack.config.js b/src/apis/apihub/webpack.config.js new file mode 100644 index 0000000000..227d899821 --- /dev/null +++ b/src/apis/apihub/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Apihub', + filename: 'apihub.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 396dfd2f50..1356620b5c 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -6126,6 +6126,7 @@ export namespace appengine_v1 { export class Resource$Projects$Locations$Applications { context: APIRequestContext; authorizedDomains: Resource$Projects$Locations$Applications$Authorizeddomains; + domainMappings: Resource$Projects$Locations$Applications$Domainmappings; services: Resource$Projects$Locations$Applications$Services; constructor(context: APIRequestContext) { this.context = context; @@ -6133,6 +6134,10 @@ export namespace appengine_v1 { new Resource$Projects$Locations$Applications$Authorizeddomains( this.context ); + this.domainMappings = + new Resource$Projects$Locations$Applications$Domainmappings( + this.context + ); this.services = new Resource$Projects$Locations$Applications$Services( this.context ); @@ -6381,6 +6386,132 @@ export namespace appengine_v1 { projectsId?: string; } + export class Resource$Projects$Locations$Applications$Domainmappings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the specified domain mapping. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Applications$Domainmappings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Domainmappings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Domainmappings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Domainmappings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'projectsId', + 'locationsId', + 'applicationsId', + 'domainMappingsId', + ], + pathParams: [ + 'applicationsId', + 'domainMappingsId', + 'locationsId', + 'projectsId', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Applications$Domainmappings$Get + extends StandardParameters { + /** + * Part of `name`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + domainMappingsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. + */ + projectsId?: string; + } + export class Resource$Projects$Locations$Applications$Services { context: APIRequestContext; versions: Resource$Projects$Locations$Applications$Services$Versions; @@ -6490,6 +6621,105 @@ export namespace appengine_v1 { return createAPIRequest(parameters); } } + + /** + * Updates the configuration of the specified 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. + */ + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Applications$Services$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Services$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Services$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Services$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'projectsId', + 'locationsId', + 'applicationsId', + 'servicesId', + ], + pathParams: [ + 'applicationsId', + 'locationsId', + 'projectsId', + 'servicesId', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Applications$Services$Delete @@ -6511,6 +6741,38 @@ export namespace appengine_v1 { */ servicesId?: string; } + export interface Params$Resource$Projects$Locations$Applications$Services$Patch + extends StandardParameters { + /** + * Part of `name`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). + */ + migrateTraffic?: boolean; + /** + * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default. + */ + projectsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + servicesId?: string; + /** + * Required. Standard field mask for the set of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } export class Resource$Projects$Locations$Applications$Services$Versions { context: APIRequestContext; diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index 5c70b127c7..5b43c78b80 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -2582,12 +2582,17 @@ export namespace appengine_v1alpha { export class Resource$Projects$Locations$Applications { context: APIRequestContext; authorizedDomains: Resource$Projects$Locations$Applications$Authorizeddomains; + domainMappings: Resource$Projects$Locations$Applications$Domainmappings; constructor(context: APIRequestContext) { this.context = context; this.authorizedDomains = new Resource$Projects$Locations$Applications$Authorizeddomains( this.context ); + this.domainMappings = + new Resource$Projects$Locations$Applications$Domainmappings( + this.context + ); } } @@ -2720,6 +2725,132 @@ export namespace appengine_v1alpha { projectsId?: string; } + export class Resource$Projects$Locations$Applications$Domainmappings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the specified domain mapping. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Applications$Domainmappings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Domainmappings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Domainmappings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Domainmappings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'projectsId', + 'locationsId', + 'applicationsId', + 'domainMappingsId', + ], + pathParams: [ + 'applicationsId', + 'domainMappingsId', + 'locationsId', + 'projectsId', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Applications$Domainmappings$Get + extends StandardParameters { + /** + * Part of `name`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + domainMappingsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. + */ + projectsId?: string; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 4049da7d60..2659e067f0 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -6398,6 +6398,7 @@ export namespace appengine_v1beta { export class Resource$Projects$Locations$Applications { context: APIRequestContext; authorizedDomains: Resource$Projects$Locations$Applications$Authorizeddomains; + domainMappings: Resource$Projects$Locations$Applications$Domainmappings; services: Resource$Projects$Locations$Applications$Services; constructor(context: APIRequestContext) { this.context = context; @@ -6405,6 +6406,10 @@ export namespace appengine_v1beta { new Resource$Projects$Locations$Applications$Authorizeddomains( this.context ); + this.domainMappings = + new Resource$Projects$Locations$Applications$Domainmappings( + this.context + ); this.services = new Resource$Projects$Locations$Applications$Services( this.context ); @@ -6653,6 +6658,132 @@ export namespace appengine_v1beta { projectsId?: string; } + export class Resource$Projects$Locations$Applications$Domainmappings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the specified domain mapping. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Applications$Domainmappings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Applications$Domainmappings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Domainmappings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Domainmappings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Domainmappings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/domainMappings/{domainMappingsId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'projectsId', + 'locationsId', + 'applicationsId', + 'domainMappingsId', + ], + pathParams: [ + 'applicationsId', + 'domainMappingsId', + 'locationsId', + 'projectsId', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Applications$Domainmappings$Get + extends StandardParameters { + /** + * Part of `name`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + domainMappingsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. + */ + projectsId?: string; + } + export class Resource$Projects$Locations$Applications$Services { context: APIRequestContext; versions: Resource$Projects$Locations$Applications$Services$Versions; @@ -6762,6 +6893,105 @@ export namespace appengine_v1beta { return createAPIRequest(parameters); } } + + /** + * Updates the configuration of the specified 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. + */ + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Applications$Services$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Applications$Services$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Applications$Services$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Applications$Services$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Applications$Services$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'projectsId', + 'locationsId', + 'applicationsId', + 'servicesId', + ], + pathParams: [ + 'applicationsId', + 'locationsId', + 'projectsId', + 'servicesId', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Applications$Services$Delete @@ -6783,6 +7013,38 @@ export namespace appengine_v1beta { */ servicesId?: string; } + export interface Params$Resource$Projects$Locations$Applications$Services$Patch + extends StandardParameters { + /** + * Part of `name`. See documentation of `projectsId`. + */ + applicationsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + locationsId?: string; + /** + * Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). + */ + migrateTraffic?: boolean; + /** + * Part of `name`. Name of the resource to update. Example: apps/myapp/services/default. + */ + projectsId?: string; + /** + * Part of `name`. See documentation of `projectsId`. + */ + servicesId?: string; + /** + * Required. Standard field mask for the set of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Service; + } export class Resource$Projects$Locations$Applications$Services$Versions { context: APIRequestContext; diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index fa163b93a2..fce0851b2e 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -365,6 +365,10 @@ export namespace backupdr_v1 { * Output only. The description of the Backup instance (2048 characters or less). */ description?: string | null; + /** + * Output only. Disk specific backup properties. + */ + diskBackupProperties?: Schema$DiskBackupProperties; /** * Optional. The backup can not be deleted before this time. */ @@ -684,6 +688,10 @@ export namespace backupdr_v1 { * Output only. The `State` for the `BackupPlan`. */ state?: string | null; + /** + * Output only. All resource types to which backupPlan can be applied. + */ + supportedResourceTypes?: string[] | null; /** * Output only. When the `BackupPlan` was last updated. */ @@ -1088,6 +1096,10 @@ export namespace backupdr_v1 { * Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view. */ export interface Schema$DataSource { + /** + * Output only. This field is set to true if the backup is blocked by vault access restriction. + */ + backupBlockedByVaultAccessRestriction?: boolean | null; /** * Output only. Details of how the resource is configured for backup. */ @@ -1178,6 +1190,10 @@ export namespace backupdr_v1 { * ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level. */ computeInstanceDatasourceProperties?: Schema$ComputeInstanceDataSourceProperties; + /** + * DiskDataSourceProperties has a subset of Disk properties that are useful at the Datasource level. + */ + diskDatasourceProperties?: Schema$DiskDataSourceProperties; /** * Output only. Full resource pathname URL of the source Google Cloud resource. */ @@ -1191,6 +1207,158 @@ export namespace backupdr_v1 { */ type?: string | null; } + /** + * DiskBackupProperties represents the properties of a Disk backup. + */ + export interface Schema$DiskBackupProperties { + /** + * The architecture of the source disk. Valid values are ARM64 or X86_64. + */ + architecture?: string | null; + /** + * A description of the source disk. + */ + description?: string | null; + /** + * A list of guest OS features that are applicable to this backup. + */ + guestOsFeature?: Schema$GuestOsFeature[]; + /** + * A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image. + */ + licenses?: string[] | null; + /** + * Region and zone are mutually exclusive fields. The URL of the region of the source disk. + */ + region?: string | null; + /** + * The URL of the Zones where the source disk should be replicated. + */ + replicaZones?: string[] | null; + /** + * Size(in GB) of the source disk. + */ + sizeGb?: string | null; + /** + * The source disk used to create this backup. + */ + sourceDisk?: string | null; + /** + * The URL of the type of the disk. + */ + type?: string | null; + /** + * The URL of the Zone where the source disk. + */ + zone?: string | null; + } + /** + * DiskDataSourceProperties represents the properties of a Disk resource that are stored in the DataSource. . + */ + export interface Schema$DiskDataSourceProperties { + /** + * The description of the disk. + */ + description?: string | null; + /** + * Name of the disk backed up by the datasource. + */ + name?: string | null; + /** + * The size of the disk in GB. + */ + sizeGb?: string | null; + /** + * The type of the disk. + */ + type?: string | null; + } + /** + * DiskRestoreProperties represents the properties of a Disk restore. + */ + export interface Schema$DiskRestoreProperties { + /** + * Optional. The access mode of the disk. + */ + accessMode?: string | null; + /** + * Optional. The architecture of the source disk. Valid values are ARM64 or X86_64. + */ + architecture?: string | null; + /** + * Optional. An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Optional. Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. + */ + diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * Optional. Indicates whether this disk is using confidential compute mode. Encryption with a Cloud KMS key is required to enable this option. + */ + enableConfidentialCompute?: boolean | null; + /** + * Optional. A list of features to enable in the guest operating system. This is applicable only for bootable images. + */ + guestOsFeature?: Schema$GuestOsFeature[]; + /** + * Optional. Labels to apply to this disk. These can be modified later using setLabels method. Label values can be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image + */ + licenses?: string[] | null; + /** + * Required. Name of the disk.. + */ + name?: string | null; + /** + * Optional. Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently, the supported size is 4096. + */ + physicalBlockSizeBytes?: string | null; + /** + * Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. + */ + provisionedIops?: string | null; + /** + * Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. + */ + provisionedThroughput?: string | null; + /** + * Optional. Resource manager tags to be bound to the disk. + */ + resourceManagerTags?: {[key: string]: string} | null; + /** + * Optional. Resource policies applied to this disk. + */ + resourcePolicy?: string[] | null; + /** + * Required. The size of the disk in GB. + */ + sizeGb?: string | null; + /** + * Optional. The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. + */ + storagePool?: string | null; + /** + * Required. URL of the disk type resource describing which disk type to use to create the disk. + */ + type?: string | null; + } + /** + * DiskTargetEnvironment represents the target environment for the disk. + */ + export interface Schema$DiskTargetEnvironment { + /** + * Required. Target project for the disk. + */ + project?: string | null; + /** + * Required. Target zone for the disk. + */ + zone?: string | null; + } /** * A set of Display Device options */ @@ -1892,6 +2060,23 @@ export namespace backupdr_v1 { */ version?: number | null; } + /** + * RegionDiskTargetEnvironment represents the target environment for the disk. + */ + export interface Schema$RegionDiskTargetEnvironment { + /** + * Required. Target project for the disk. + */ + project?: string | null; + /** + * Required. Target region for the disk. + */ + region?: string | null; + /** + * Required. Target URLs of the replica zones for the disk. + */ + replicaZones?: string[] | null; + } /** * Message for deleting a DataSource. */ @@ -1954,6 +2139,18 @@ export namespace backupdr_v1 { * Compute Engine target environment to be used during restore. */ computeInstanceTargetEnvironment?: Schema$ComputeInstanceTargetEnvironment; + /** + * Disk properties to be overridden during restore. + */ + diskRestoreProperties?: Schema$DiskRestoreProperties; + /** + * Disk target environment to be used during restore. + */ + diskTargetEnvironment?: Schema$DiskTargetEnvironment; + /** + * Region disk target environment to be used during restore. + */ + regionDiskTargetEnvironment?: Schema$RegionDiskTargetEnvironment; /** * 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). */ @@ -2858,6 +3055,92 @@ export namespace backupdr_v1 { } } + /** + * Update a BackupPlanAssociation + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backupplanassociations$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backupplanassociations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backupplanassociations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupplanassociations$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupplanassociations$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplanassociations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplanassociations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplanassociations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Triggers a new Backup. * @@ -3005,6 +3288,26 @@ export namespace backupdr_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Backupplanassociations$Patch + extends StandardParameters { + /** + * Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project\}/locations/{location\}/backupPlanAssociations/{backupPlanAssociationId\} + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlanAssociation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently backup_plan_association.backup_plan is the only supported field. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupPlanAssociation; + } export interface Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup extends StandardParameters { /** @@ -4200,6 +4503,10 @@ export namespace backupdr_v1 { * Optional. If set to true, will not check plan duration against backup vault enforcement duration. */ force?: boolean; + /** + * Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'. + */ + forceUpdateAccessRestriction?: boolean; /** * Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project\}/locations/{location\}/backupVaults/{backupvault\}"`. `{backupvault\}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location. */ diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 48a52added..a4df01deec 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -1052,6 +1052,7 @@ export namespace bigquery_v2 { */ datasets?: Array<{ datasetReference?: Schema$DatasetReference; + externalDatasetReference?: Schema$ExternalDatasetReference; friendlyName?: string; id?: string; kind?: string; @@ -2431,7 +2432,7 @@ export namespace bigquery_v2 { */ useAvroLogicalTypes?: boolean | null; /** - * Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + * Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints and uses the schema from the load job. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */ writeDisposition?: string | null; } @@ -2544,7 +2545,7 @@ export namespace bigquery_v2 { */ userDefinedFunctionResources?: Schema$UserDefinedFunctionResource[]; /** - * Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. + * Optional. Specifies the action that occurs if the destination table already exists. The following values are supported: * WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the data, removes the constraints, and uses the schema from the query result. * WRITE_TRUNCATE_DATA: If the table already exists, BigQuery overwrites the data, but keeps the constraints and schema of the existing table. * WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. * WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. */ writeDisposition?: string | null; /** diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index 90134fb2af..4058d5972b 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -129,7 +129,7 @@ export namespace bigqueryreservation_v1 { */ export interface Schema$Assignment { /** - * The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. + * Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. */ assignee?: string | null; /** @@ -137,7 +137,7 @@ export namespace bigqueryreservation_v1 { */ enableGeminiInBigquery?: boolean | null; /** - * Which type of jobs will use the reservation. + * Optional. Which type of jobs will use the reservation. */ jobType?: string | null; /** @@ -149,6 +149,32 @@ export namespace bigqueryreservation_v1 { */ state?: string | null; } + /** + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + */ + service?: string | null; + } + /** + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } /** * Auto scaling settings. */ @@ -162,20 +188,37 @@ export namespace bigqueryreservation_v1 { */ maxSlots?: string | null; } + /** + * Associates `members`, or principals, with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + condition?: Schema$Expr; + /** + * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + */ + members?: string[] | null; + /** + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + */ + role?: string | null; + } /** * Represents a BI Reservation. */ export interface Schema$BiReservation { /** - * The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id\}/locations/{location_id\}/biReservation`. + * Identifier. The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id\}/locations/{location_id\}/biReservation`. */ name?: string | null; /** - * Preferred tables to use BI capacity for. + * Optional. Preferred tables to use BI capacity for. */ preferredTables?: Schema$TableReference[]; /** - * Size of a reservation, in bytes. + * Optional. Size of a reservation, in bytes. */ size?: string | null; /** @@ -196,7 +239,7 @@ export namespace bigqueryreservation_v1 { */ commitmentStartTime?: string | null; /** - * Edition of the capacity commitment. + * Optional. Edition of the capacity commitment. */ edition?: string | null; /** @@ -216,15 +259,15 @@ export namespace bigqueryreservation_v1 { */ name?: string | null; /** - * Capacity commitment commitment plan. + * Optional. Capacity commitment commitment plan. */ plan?: string | null; /** - * The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. + * Optional. The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. */ renewalPlan?: string | null; /** - * Number of slots in this commitment. + * Optional. Number of slots in this commitment. */ slotCount?: string | null; /** @@ -236,6 +279,27 @@ 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 {} + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } /** * The request for ReservationService.FailoverReservation. */ @@ -305,6 +369,27 @@ export namespace bigqueryreservation_v1 { */ destinationId?: string | null; } + /** + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + version?: number | null; + } /** * Disaster Recovery(DR) replication status of the reservation. */ @@ -417,6 +502,19 @@ export namespace bigqueryreservation_v1 { */ nextPageToken?: string | null; } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + */ + policy?: Schema$Policy; + /** + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` + */ + updateMask?: string | null; + } /** * The request for ReservationService.SplitCapacityCommitment. */ @@ -461,18 +559,36 @@ export namespace bigqueryreservation_v1 { */ export interface Schema$TableReference { /** - * The ID of the dataset in the above project. + * Optional. The ID of the dataset in the above project. */ datasetId?: string | null; /** - * The assigned project ID of the project. + * Optional. The assigned project ID of the project. */ projectId?: string | null; /** - * The ID of the table in the above dataset. + * Optional. The ID of the table in the above dataset. */ tableId?: string | null; } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } export class Resource$Projects { context: APIRequestContext; @@ -915,7 +1031,7 @@ export namespace bigqueryreservation_v1 { export interface Params$Resource$Projects$Locations$Updatebireservation extends StandardParameters { /** - * The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id\}/locations/{location_id\}/biReservation`. + * Identifier. The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id\}/locations/{location_id\}/biReservation`. */ name?: string; /** @@ -2040,6 +2156,96 @@ export namespace bigqueryreservation_v1 { } } + /** + * Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Reservations To call this method, you must have the following Google IAM permissions: - `bigqueryreservation.reservations.getIamPolicy` to get policies on reservations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Reservations$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Reservations$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Reservations$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Reservations$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Reservations$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reservations$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryreservation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists all the reservations for the project in the specified location. * @@ -2219,6 +2425,193 @@ export namespace bigqueryreservation_v1 { return createAPIRequest(parameters); } } + + /** + * Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Reservations To call this method, you must have the following Google IAM permissions: - `bigqueryreservation.reservations.setIamPolicy` to set policies on reservations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Reservations$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Reservations$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Reservations$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Reservations$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Reservations$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reservations$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryreservation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Reservations No Google IAM permissions are required to call this method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Reservations$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Reservations$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Reservations$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Reservations$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Reservations$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reservations$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reservations$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reservations$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigqueryreservation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Reservations$Create @@ -2263,6 +2656,17 @@ export namespace bigqueryreservation_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Reservations$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$Reservations$List extends StandardParameters { /** @@ -2294,6 +2698,30 @@ export namespace bigqueryreservation_v1 { */ requestBody?: Schema$Reservation; } + export interface Params$Resource$Projects$Locations$Reservations$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Reservations$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } export class Resource$Projects$Locations$Reservations$Assignments { context: APIRequestContext; diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index aa3247a4c3..7565cde6e1 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -1427,7 +1427,6 @@ export namespace chat_v1 { * For multiselect menus, a text description or label that's displayed below the item's `text` field. */ bottomText?: string | null; - materialIcon?: Schema$GoogleAppsCardV1MaterialIcon; /** * Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item. */ @@ -2811,7 +2810,7 @@ export namespace chat_v1 { } /** - * Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2896,7 +2895,7 @@ export namespace chat_v1 { } /** - * Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Deletes a custom emoji. By default, users can only delete custom emoji they created. [Emoji managers](https://support.google.com/a/answer/12850085) assigned by the administrator can delete any custom emoji in the organization. See [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149). Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2981,7 +2980,7 @@ export namespace chat_v1 { } /** - * Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3065,7 +3064,7 @@ export namespace chat_v1 { } /** - * Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.customemojis.readonly` - `https://www.googleapis.com/auth/chat.customemojis` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3285,7 +3284,7 @@ export namespace chat_v1 { } /** - * Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat). + * Uploads an attachment. For an example, see [Upload media as a file attachment](https://developers.google.com/workspace/chat/upload-media-attachments). Requires user [authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) You can upload attachments up to 200 MB. Certain file types aren't supported. For details, see [File types blocked by Google Chat](https://support.google.com/chat/answer/7651457?&co=GENIE.Platform%3DDesktop#File%20types%20blocked%20in%20Google%20Chat). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3429,7 +3428,7 @@ export namespace chat_v1 { } /** - * Completes the [import process](https://developers.google.com/workspace/chat/import-data) for the specified space and makes it visible to users. Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and domain-wide delegation. For more information, see [Authorize Google Chat apps to import data](https://developers.google.com/workspace/chat/authorize-import). + * Completes the [import process](https://developers.google.com/workspace/chat/import-data) for the specified space and makes it visible to users. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) and domain-wide delegation with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.import` For more information, see [Authorize Google Chat apps to import data](https://developers.google.com/workspace/chat/authorize-import). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3524,7 +3523,7 @@ export namespace chat_v1 { } /** - * Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When authenticating as an app, the `space.customer` field must be set in the request. Space membership upon creation depends on whether the space is created in `Import mode`: * **Import mode:** No members are created. * **All other modes:** The calling user is added as a member. This is: * The app itself when using app authentication. * The human user when using user authentication. If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. + * Creates a space. Can be used to create a named space, or a group chat in `Import mode`. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces.create` - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When authenticating as an app, the `space.customer` field must be set in the request. Space membership upon creation depends on whether the space is created in `Import mode`: * **Import mode:** No members are created. * **All other modes:** The calling user is added as a member. This is: * The app itself when using app authentication. * The human user when using user authentication. If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3608,7 +3607,7 @@ export namespace chat_v1 { } /** - * Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - Developer Preview: [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth). Requires that the Chat app created the space using app authentication. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. + * Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.delete` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.delete` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.delete` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3692,7 +3691,7 @@ export namespace chat_v1 { } /** - * Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. // Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) + * Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3780,7 +3779,7 @@ export namespace chat_v1 { } /** - * Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. + * Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator approval](https://support.google.com/a?p=chat-app-auth) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3864,7 +3863,7 @@ export namespace chat_v1 { } /** - * Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead. + * Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3951,7 +3950,7 @@ export namespace chat_v1 { } /** - * Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. + * Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4035,7 +4034,7 @@ export namespace chat_v1 { } /** - * Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges). In the request, set `use_admin_access` to `true`. + * Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges) and one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` In the request, set `use_admin_access` to `true`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4124,7 +4123,7 @@ export namespace chat_v1 { } /** - * Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user\}`, where `{user\}` can be the email address for the user. For users in the same Workspace organization `{user\}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group\}`, where `{group\}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see [Set up a space with initial members](https://developers.google.com/workspace/chat/set-up-spaces). To specify the human members to add, add memberships with the appropriate `membership.member.name`. To add a human user, use `users/{user\}`, where `{user\}` can be the email address for the user. For users in the same Workspace organization `{user\}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. To specify the Google groups to add, add memberships with the appropriate `membership.group_member.name`. To add or invite a Google group, use `groups/{group\}`, where `{group\}` is the `id` for the group from the Cloud Identity Groups API. For example, you can use [Cloud Identity Groups lookup API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup) to retrieve the ID `123456789` for group email `group@example.com`, then you can add the group to the space by setting the `membership.group_member.name` to `groups/123456789`. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set `Space.singleUserBotDm` to `true` and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see [Invite or add a user or app to a space](https://developers.google.com/workspace/chat/create-members). If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.create` - `https://www.googleapis.com/auth/chat.spaces` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4327,7 +4326,7 @@ export namespace chat_v1 { } /** - * Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api). + * Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to add the calling app to the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4415,7 +4414,7 @@ export namespace chat_v1 { } /** - * Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the application must be the space creator. + * Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to remove the calling app from the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the application must be the space creator. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4500,7 +4499,7 @@ export namespace chat_v1 { } /** - * Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. + * Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4585,7 +4584,7 @@ export namespace chat_v1 { } /** - * Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. + * Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4678,7 +4677,7 @@ export namespace chat_v1 { } /** - * Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - Developer Preview: [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth). Requires that the Chat app created the space using app authentication. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) You can authenticate and authorize this method with administrator privileges by setting the `use_admin_access` field in the request. + * Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` (only in spaces the app created) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4864,7 +4863,7 @@ export namespace chat_v1 { } /** - * Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). The `create()` method requires either [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authorize-import). Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`). ![Message sent with app authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`). ![Message sent with user authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) The maximum message size, including the message contents, is 32,000 bytes. For [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) requests, the response doesn't contain the full message. The response only populates the `name` and `thread.name` fields in addition to the information that was in the request. + * Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.create` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`). ![Message sent with app authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`). ![Message sent with user authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) The maximum message size, including the message contents, is 32,000 bytes. For [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) requests, the response doesn't contain the full message. The response only populates the `name` and `thread.name` fields in addition to the information that was in the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4952,7 +4951,7 @@ export namespace chat_v1 { } /** - * Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only delete messages created by the calling Chat app. + * Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only delete messages created by the calling Chat app. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5037,7 +5036,7 @@ export namespace chat_v1 { } /** - * Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) Note: Might return a message from a blocked member or space. + * Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5122,7 +5121,7 @@ export namespace chat_v1 { } /** - * Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{\}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{\}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5215,7 +5214,7 @@ export namespace chat_v1 { } /** - * Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only update messages created by the calling Chat app. + * Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5300,7 +5299,7 @@ export namespace chat_v1 { } /** - * Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only update messages created by the calling Chat app. + * Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5506,7 +5505,7 @@ export namespace chat_v1 { } /** - * Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download). For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-attachments). Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * Gets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download). For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-attachments). Requires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.bot` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5606,7 +5605,7 @@ export namespace chat_v1 { } /** - * Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Creates a reaction and adds it to a message. For an example, see [Add a reaction to a message](https://developers.google.com/workspace/chat/create-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.create` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5694,7 +5693,7 @@ export namespace chat_v1 { } /** - * Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Deletes a reaction to a message. For an example, see [Delete a reaction](https://developers.google.com/workspace/chat/delete-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5779,7 +5778,7 @@ export namespace chat_v1 { } /** - * Lists reactions to a message. For an example, see [List reactions for a message](https://developers.google.com/workspace/chat/list-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Lists reactions to a message. For an example, see [List reactions for a message](https://developers.google.com/workspace/chat/list-reactions). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5918,7 +5917,7 @@ export namespace chat_v1 { } /** - * Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event). + * Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6003,7 +6002,7 @@ export namespace chat_v1 { } /** - * Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events). + * Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6144,7 +6143,7 @@ export namespace chat_v1 { } /** - * Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Returns details about a user's read state within a space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6231,7 +6230,7 @@ export namespace chat_v1 { } /** - * Updates a user's read state within a space, used to identify read and unread messages. For an example, see [Update a user's space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Updates a user's read state within a space, used to identify read and unread messages. For an example, see [Update a user's space read state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6349,7 +6348,7 @@ export namespace chat_v1 { } /** - * Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Gets the space notification setting. For an example, see [Get the caller's space notification setting](https://developers.google.com/workspace/chat/get-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6440,7 +6439,7 @@ export namespace chat_v1 { } /** - * Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Updates the space notification setting. For an example, see [Update the caller's space notification setting](https://developers.google.com/workspace/chat/update-space-notification-setting). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6564,7 +6563,7 @@ export namespace chat_v1 { } /** - * Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/chromepolicy/v1.ts b/src/apis/chromepolicy/v1.ts index 393f409fac..d9ddbea13b 100644 --- a/src/apis/chromepolicy/v1.ts +++ b/src/apis/chromepolicy/v1.ts @@ -914,7 +914,7 @@ export namespace chromepolicy_v1 { */ export interface Schema$Proto2FileDescriptorProto { /** - * BEGIN GOOGLE-INTERNAL TODO(b/297898292) Deprecate and remove this field in favor of enums. END GOOGLE-INTERNAL + * copybara:strip_begin TODO(b/297898292) Deprecate and remove this field in favor of enums. copybara:strip_end */ editionDeprecated?: string | null; enumType?: Schema$Proto2EnumDescriptorProto[]; diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 3819a762bd..aeacd60075 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -791,6 +791,10 @@ export namespace cloudbuild_v1 { * Human-readable description of this trigger. */ description?: string | null; + /** + * Optional. The configuration of a trigger that creates a build whenever an event from the DeveloperConnect API is received. + */ + developerConnectEventConfig?: Schema$DeveloperConnectEventConfig; /** * If true, the trigger will never automatically execute a build. */ @@ -1136,6 +1140,27 @@ export namespace cloudbuild_v1 { */ revision?: string | null; } + /** + * The configuration of a trigger that creates a build whenever an event from the DeveloperConnect API is received. + */ + export interface Schema$DeveloperConnectEventConfig { + /** + * Required. The Developer Connect Git repository link, formatted as `projects/x/locations/x/connections/x/gitRepositoryLink/x`. + */ + gitRepositoryLink?: string | null; + /** + * Output only. The type of DeveloperConnect GitRepositoryLink. + */ + gitRepositoryLinkType?: string | null; + /** + * Filter to match changes in pull requests. + */ + pullRequest?: Schema$PullRequestFilter; + /** + * Filter to match changes in refs like branches and tags. + */ + push?: Schema$PushFilter; + } /** * 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); \} */ @@ -1740,7 +1765,7 @@ export namespace cloudbuild_v1 { */ groupId?: string | null; /** - * Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. + * Optional. Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. */ path?: string | null; /** @@ -2518,7 +2543,7 @@ export namespace cloudbuild_v1 { */ name?: string | null; /** - * Legacy Private Pool configuration. + * Private Pool configuration. */ privatePoolV1Config?: Schema$PrivatePoolV1Config; /** diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index b664c0b607..3572458967 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -289,6 +289,14 @@ export namespace cloudfunctions_v1 { * The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime). */ runtime?: string | null; + /** + * Output only. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. + */ + satisfiesPzs?: boolean | null; /** * Secret environment variables configuration. */ diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 00dc796eab..0959cad3e5 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -830,7 +830,7 @@ export namespace cloudkms_v1 { */ nextPageToken?: string | null; /** - * The total number of CryptoKeys that matched the query. + * The total number of CryptoKeys that matched the query. This field is not populated if ListCryptoKeysRequest.filter is applied. */ totalSize?: number | null; } @@ -847,7 +847,7 @@ export namespace cloudkms_v1 { */ nextPageToken?: string | null; /** - * The total number of CryptoKeyVersions that matched the query. + * The total number of CryptoKeyVersions that matched the query. This field is not populated if ListCryptoKeyVersionsRequest.filter is applied. */ totalSize?: number | null; } @@ -864,7 +864,7 @@ export namespace cloudkms_v1 { */ nextPageToken?: string | null; /** - * The total number of EkmConnections that matched the query. + * The total number of EkmConnections that matched the query. This field is not populated if ListEkmConnectionsRequest.filter is applied. */ totalSize?: number | null; } @@ -881,7 +881,7 @@ export namespace cloudkms_v1 { */ nextPageToken?: string | null; /** - * The total number of ImportJobs that matched the query. + * The total number of ImportJobs that matched the query. This field is not populated if ListImportJobsRequest.filter is applied. */ totalSize?: number | null; } @@ -911,7 +911,7 @@ export namespace cloudkms_v1 { */ nextPageToken?: string | null; /** - * The total number of KeyRings that matched the query. + * The total number of KeyRings that matched the query. This field is not populated if ListKeyRingsRequest.filter is applied. */ totalSize?: number | null; } diff --git a/src/apis/cloudresourcemanager/v3.ts b/src/apis/cloudresourcemanager/v3.ts index 6c94d4854d..5475c84022 100644 --- a/src/apis/cloudresourcemanager/v3.ts +++ b/src/apis/cloudresourcemanager/v3.ts @@ -387,7 +387,7 @@ export namespace cloudresourcemanager_v3 { */ managementProject?: string | null; /** - * Output only. The resource name of the folder. Its format is `folders/{folder_id\}`, for example: "folders/1234". + * Identifier. The resource name of the folder. Its format is `folders/{folder_id\}`, for example: "folders/1234". */ name?: string | null; /** @@ -2179,7 +2179,7 @@ export namespace cloudresourcemanager_v3 { } export interface Params$Resource$Folders$Patch extends StandardParameters { /** - * Output only. The resource name of the folder. Its format is `folders/{folder_id\}`, for example: "folders/1234". + * Identifier. The resource name of the folder. Its format is `folders/{folder_id\}`, for example: "folders/1234". */ name?: string; /** diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index 4dc2248e49..304a9fb8db 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -952,6 +952,10 @@ export namespace composer_v1 { */ scheduledSnapshotsConfig?: Schema$ScheduledSnapshotsConfig; } + /** + * Restart Airflow web server. + */ + export interface Schema$RestartWebServerRequest {} /** * Request to create a snapshot of a Cloud Composer environment. */ @@ -2289,6 +2293,95 @@ export namespace composer_v1 { } } + /** + * Restart Airflow web server. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + restartWebServer( + params: Params$Resource$Projects$Locations$Environments$Restartwebserver, + options: StreamMethodOptions + ): GaxiosPromise; + restartWebServer( + params?: Params$Resource$Projects$Locations$Environments$Restartwebserver, + options?: MethodOptions + ): GaxiosPromise; + restartWebServer( + params: Params$Resource$Projects$Locations$Environments$Restartwebserver, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restartWebServer( + params: Params$Resource$Projects$Locations$Environments$Restartwebserver, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restartWebServer( + params: Params$Resource$Projects$Locations$Environments$Restartwebserver, + callback: BodyResponseCallback + ): void; + restartWebServer(callback: BodyResponseCallback): void; + restartWebServer( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Environments$Restartwebserver + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Environments$Restartwebserver; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Environments$Restartwebserver; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://composer.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:restartWebServer').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest. * @@ -2599,6 +2692,18 @@ export namespace composer_v1 { */ requestBody?: Schema$PollAirflowCommandRequest; } + export interface Params$Resource$Projects$Locations$Environments$Restartwebserver + extends StandardParameters { + /** + * Required. The resource name of the environment to restart the web server for, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestartWebServerRequest; + } export interface Params$Resource$Projects$Locations$Environments$Savesnapshot extends StandardParameters { /** diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 1116db7863..2afd41a70a 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -2700,7 +2700,7 @@ export namespace composer_v1beta1 { export interface Params$Resource$Projects$Locations$Environments$Restartwebserver extends StandardParameters { /** - * The resource name of the environment to restart the web server for, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" + * Required. The resource name of the environment to restart the web server for, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ name?: string; diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index eba6e57f3f..039d2f4a26 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -176,6 +176,7 @@ export namespace compute_alpha { publicAdvertisedPrefixes: Resource$Publicadvertisedprefixes; publicDelegatedPrefixes: Resource$Publicdelegatedprefixes; regionAutoscalers: Resource$Regionautoscalers; + regionBackendBuckets: Resource$Regionbackendbuckets; regionBackendServices: Resource$Regionbackendservices; regionCommitments: Resource$Regioncommitments; regionCompositeHealthChecks: Resource$Regioncompositehealthchecks; @@ -335,6 +336,9 @@ export namespace compute_alpha { this.context ); this.regionAutoscalers = new Resource$Regionautoscalers(this.context); + this.regionBackendBuckets = new Resource$Regionbackendbuckets( + this.context + ); this.regionBackendServices = new Resource$Regionbackendservices( this.context ); @@ -2006,7 +2010,7 @@ export namespace compute_alpha { */ name?: string | null; /** - * The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL. + * The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL, or when the load balancing scheme is set to EXTERNAL and haPolicy fastIpMove is enabled. */ network?: string | null; /** @@ -2958,6 +2962,123 @@ export namespace compute_alpha { */ fromPlugin?: Schema$MetadataCredentialsFromPlugin; } + /** + * A request to provide Assistant Scores. These scores determine VM obtainability and preemption likelihood. + */ + export interface Schema$CapacityAdviceRequest { + /** + * Policy specifying the distribution of instances across zones within the requested region. + */ + distributionPolicy?: Schema$CapacityAdviceRequestDistributionPolicy; + /** + * Policy for instance selectors. + */ + instanceFlexibilityPolicy?: Schema$CapacityAdviceRequestInstanceFlexibilityPolicy; + /** + * Instance properties for this request. + */ + instanceProperties?: Schema$CapacityAdviceRequestInstanceProperties; + } + export interface Schema$CapacityAdviceRequestDistributionPolicy { + /** + * The distribution shape to which the group converges. + */ + targetShape?: string | null; + /** + * Zones where Capacity Advisor looks for capacity. + */ + zones?: Schema$CapacityAdviceRequestDistributionPolicyZoneConfiguration[]; + } + export interface Schema$CapacityAdviceRequestDistributionPolicyZoneConfiguration { + /** + * The URL of the zone. + */ + zone?: string | null; + } + /** + * Specification of alternative, flexible instance subsets. + */ + export interface Schema$CapacityAdviceRequestInstanceFlexibilityPolicy { + /** + * Named instance selections configure properties. The key is an arbitrary, unique RFC1035 string that identifies the instance selection. + */ + instanceSelections?: { + [ + key: string + ]: Schema$CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelection; + } | null; + } + /** + * Machine specification. + */ + export interface Schema$CapacityAdviceRequestInstanceFlexibilityPolicyInstanceSelection { + /** + * Full machine-type names, e.g. "n1-standard-16". + */ + machineTypes?: string[] | null; + } + /** + * Instance provisining properties. + */ + export interface Schema$CapacityAdviceRequestInstanceProperties { + /** + * Specifies the scheduling options. + */ + scheduling?: Schema$CapacityAdviceRequestInstancePropertiesScheduling; + } + /** + * Defines the instance scheduling options. + */ + export interface Schema$CapacityAdviceRequestInstancePropertiesScheduling { + /** + * Specifies the provisioning model of the instance. + */ + provisioningModel?: string | null; + } + /** + * A response contains multiple scoring recommendations. + */ + export interface Schema$CapacityAdviceResponse { + /** + * Initially the API will provide one recommendation which balances the individual scores according to Google's preference. + */ + recommendations?: Schema$CapacityAdviceResponseRecommendation[]; + } + export interface Schema$CapacityAdviceResponseRecommendation { + scores?: Schema$CapacityAdviceResponseRecommendationScores; + shards?: Schema$CapacityAdviceResponseRecommendationShard[]; + } + /** + * The Scores message groups information about a shard of capacity. + */ + export interface Schema$CapacityAdviceResponseRecommendationScores { + /** + * The obtainability score indicates the likelihood of successfully obtaining (provisioning) the requested number of VMs. The score range is 0.0 through 1.0. Higher is better. + */ + obtainability?: number | null; + /** + * The preemption score indicates the likelihood that your Spot VMs is preempted. For more information about the preemption process, see Preemption of Spot VMs. The score range is 0.0 through 1.0. Higher is better. + */ + spotPreemption?: number | null; + } + /** + * Shards represent blocks of uniform capacity in recommendations. Each shard is for a single zone, single instance selection, and a single machine shape. Each shard defines a size expressed as the number of VMs. + */ + export interface Schema$CapacityAdviceResponseRecommendationShard { + instanceCount?: number | null; + /** + * The machine type corresponds to the instance selection in the request. + */ + machineType?: string | null; + /** + * Provisioning model of the recommended capacity. + */ + provisioningModel?: string | null; + /** + * The zone name for this shard. + */ + zone?: string | null; + } /** * [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. */ @@ -5783,6 +5904,14 @@ export namespace compute_alpha { * Maintenance Info for ReservationBlocks. */ export interface Schema$GroupMaintenanceInfo { + /** + * Describes number of instances that have ongoing maintenance. + */ + instanceMaintenanceOngoingCount?: number | null; + /** + * Describes number of instances that have pending maintenance. + */ + instanceMaintenancePendingCount?: number | null; /** * Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance. */ @@ -7932,7 +8061,7 @@ export namespace compute_alpha { */ targetSize?: number | null; /** - * Configures how target size of MIG is achieved. + * The policy that specifies how the MIG creates its VMs to achieve the target size. */ targetSizePolicy?: Schema$InstanceGroupManagerTargetSizePolicy; /** @@ -8145,6 +8274,10 @@ export namespace compute_alpha { * The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - DEFAULT_ACTION (default): MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - REPAIR: MIG automatically repairs an unhealthy VM by recreating it. - DO_NOTHING: MIG doesn't repair an unhealthy VM. For more information, see About repairing VMs in a MIG. */ onFailedHealthCheck?: string | null; + /** + * Configuration for VM repairs in the MIG. + */ + onRepair?: Schema$InstanceGroupManagerInstanceLifecyclePolicyOnRepair; } export interface Schema$InstanceGroupManagerInstanceLifecyclePolicyMetadataBasedReadinessSignal { /** @@ -8152,6 +8285,15 @@ export namespace compute_alpha { */ timeoutSec?: number | null; } + /** + * Configuration for VM repairs in the MIG. + */ + export interface Schema$InstanceGroupManagerInstanceLifecyclePolicyOnRepair { + /** + * Specifies whether the MIG can change a VM's zone during repair. + */ + allowChangingZone?: string | null; + } /** * [Output Only] A list of managed instance groups. */ @@ -8557,7 +8699,7 @@ export namespace compute_alpha { */ autoscaler?: string | null; /** - * [Output Only] Status of bulk instance operation. + * [Output Only] The status of bulk instance operation. */ bulkInstanceOperation?: Schema$InstanceGroupManagerStatusBulkInstanceOperation; /** @@ -8583,19 +8725,22 @@ export namespace compute_alpha { */ effective?: boolean | null; } + /** + * Bulk instance operation is the creation of VMs in a MIG when the targetSizePolicy.mode is set to BULK. + */ export interface Schema$InstanceGroupManagerStatusBulkInstanceOperation { /** * [Output Only] Informs whether bulk instance operation is in progress. */ inProgress?: boolean | null; /** - * [Output Only] Information from last progress check of bulk instance operation. + * [Output Only] Information from the last progress check of bulk instance operation. */ lastProgressCheck?: Schema$InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck; } export interface Schema$InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck { /** - * [Output Only] Contains errors encountered during bulk instance operation. + * [Output Only] Errors encountered during bulk instance operation. */ error?: { errors?: Array<{ @@ -8652,7 +8797,7 @@ export namespace compute_alpha { } export interface Schema$InstanceGroupManagerTargetSizePolicy { /** - * Mode in which operations on size are processed. + * The mode of target size policy based on which the MIG creates its VMs individually or all at once. */ mode?: string | null; } @@ -9957,7 +10102,7 @@ export namespace compute_alpha { */ labels?: {[key: string]: string} | null; /** - * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440. + * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440. */ mtu?: number | null; /** @@ -10314,7 +10459,7 @@ export namespace compute_alpha { */ l2Forwarding?: Schema$InterconnectAttachmentL2Forwarding; /** - * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440. + * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, or 8896. If not specified, the value will default to 1440. */ mtu?: number | null; /** @@ -17213,6 +17358,10 @@ export namespace compute_alpha { * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). + */ + protectionTier?: string | null; /** * [Output only] Indicates the reservation mode of the reservation. */ @@ -18096,7 +18245,7 @@ export namespace compute_alpha { */ enableOsconfigMetadataValue?: boolean | null; /** - * Effective enable-osinventory value at Instance level. + * Effective enable-os-inventory value at Instance level. */ enableOsInventoryMetadataValue?: boolean | null; /** @@ -18107,6 +18256,10 @@ export namespace compute_alpha { * Effective serial-port-enable value at Instance level. */ serialPortEnableMetadataValue?: boolean | null; + /** + * Effective serial-port-logging-enable value at Instance level. + */ + serialPortLoggingEnableMetadataValue?: boolean | null; /** * Effective VM DNS setting at Instance level. */ @@ -19834,6 +19987,11 @@ export namespace compute_alpha { enableMl?: boolean | null; } export interface Schema$SecurityPolicyDdosProtectionConfig { + ddosAdaptiveProtection?: string | null; + /** + * Adaptive Protection for Network Load Balancers (and VMs with public IPs) builds DDos mitigations that minimize collateral damage. It quantifies this as the fraction of a non-abuse baseline that's inadvertently blocked. Rules whose collateral damage exceeds ddosAdaptiveImpactedBaselineThreshold will not be deployed. Using a lower value will prioritize keeping collateral damage low, possibly at the cost of its effectiveness in rate limiting some or all of the attack. It should typically be between 0.01 and 0.10. + */ + ddosImpactedBaselineThreshold?: number | null; ddosProtection?: string | null; } export interface Schema$SecurityPolicyList { @@ -26511,6 +26669,100 @@ export namespace compute_alpha { return createAPIRequest(parameters); } } + + /** + * Advice on making real-time decisions (such as choosing zone or machine types) during deployment to maximize your chances of obtaining capacity. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + capacity( + params: Params$Resource$Advice$Capacity, + options: StreamMethodOptions + ): GaxiosPromise; + capacity( + params?: Params$Resource$Advice$Capacity, + options?: MethodOptions + ): GaxiosPromise; + capacity( + params: Params$Resource$Advice$Capacity, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + capacity( + params: Params$Resource$Advice$Capacity, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + capacity( + params: Params$Resource$Advice$Capacity, + callback: BodyResponseCallback + ): void; + capacity( + callback: BodyResponseCallback + ): void; + capacity( + paramsOrCallback?: + | Params$Resource$Advice$Capacity + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advice$Capacity; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advice$Capacity; + 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}/regions/{region}/advice/capacity' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'size'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Advice$Calendarmode @@ -26529,6 +26781,25 @@ export namespace compute_alpha { */ requestBody?: Schema$CalendarModeAdviceRequest; } + export interface Params$Resource$Advice$Capacity extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * Size of requested capacity. + */ + size?: number; + + /** + * Request body metadata + */ + requestBody?: Schema$CapacityAdviceRequest; + } export class Resource$Autoscalers { context: APIRequestContext; @@ -81638,7 +81909,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/previewFeatures/{resourceId}' + '/compute/alpha/projects/{project}/global/previewFeatures/{previewFeature}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -81646,8 +81917,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resourceId'], - pathParams: ['project', 'resourceId'], + requiredParams: ['project', 'previewFeature'], + pathParams: ['previewFeature', 'project'], context: this.context, }; if (callback) { @@ -81817,7 +82088,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/previewFeatures/{resourceId}' + '/compute/alpha/projects/{project}/global/previewFeatures/{previewFeature}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', @@ -81825,8 +82096,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'resourceId'], - pathParams: ['project', 'resourceId'], + requiredParams: ['project', 'previewFeature'], + pathParams: ['previewFeature', 'project'], context: this.context, }; if (callback) { @@ -81843,13 +82114,13 @@ export namespace compute_alpha { export interface Params$Resource$Previewfeatures$Get extends StandardParameters { /** - * Project ID for this request. + * Name of the PreviewFeature for this request. */ - project?: string; + previewFeature?: string; /** - * Name of the PreviewFeature for this request. + * Project ID for this request. */ - resourceId?: string; + project?: string; } export interface Params$Resource$Previewfeatures$List extends StandardParameters { @@ -81880,6 +82151,10 @@ export namespace compute_alpha { } export interface Params$Resource$Previewfeatures$Update extends StandardParameters { + /** + * Name of the PreviewFeature for this request. + */ + previewFeature?: string; /** * Project ID for this request. */ @@ -81888,10 +82163,6 @@ export namespace compute_alpha { * 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 PreviewFeature for this request. - */ - resourceId?: string; /** * Request body metadata @@ -86033,6 +86304,1026 @@ export namespace compute_alpha { requestBody?: Schema$Autoscaler; } + export class Resource$Regionbackendbuckets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes the specified regional BackendBucket 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$Regionbackendbuckets$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Regionbackendbuckets$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionbackendbuckets$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionbackendbuckets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionbackendbuckets$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendbuckets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendbuckets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{backendBucket}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'backendBucket'], + pathParams: ['backendBucket', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified regional BackendBucket 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$Regionbackendbuckets$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regionbackendbuckets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionbackendbuckets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionbackendbuckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionbackendbuckets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendbuckets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendbuckets$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}/regions/{region}/backendBuckets/{backendBucket}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'backendBucket'], + pathParams: ['backendBucket', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionbackendbuckets$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Regionbackendbuckets$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Regionbackendbuckets$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regionbackendbuckets$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regionbackendbuckets$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendbuckets$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendbuckets$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a RegionBackendBucket in the specified project in the given scope using the parameters that are included in the request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Regionbackendbuckets$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Regionbackendbuckets$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionbackendbuckets$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionbackendbuckets$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionbackendbuckets$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendbuckets$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendbuckets$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/regionBackendBuckets' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the list of BackendBucket resources available to the specified project in the given region. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionbackendbuckets$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Regionbackendbuckets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionbackendbuckets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionbackendbuckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionbackendbuckets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendbuckets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendbuckets$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}/regions/{region}/backendBuckets' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of all usable backend buckets in the specified project in the given region. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listUsable( + params: Params$Resource$Regionbackendbuckets$Listusable, + options: StreamMethodOptions + ): GaxiosPromise; + listUsable( + params?: Params$Resource$Regionbackendbuckets$Listusable, + options?: MethodOptions + ): GaxiosPromise; + listUsable( + params: Params$Resource$Regionbackendbuckets$Listusable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listUsable( + params: Params$Resource$Regionbackendbuckets$Listusable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listUsable( + params: Params$Resource$Regionbackendbuckets$Listusable, + callback: BodyResponseCallback + ): void; + listUsable( + callback: BodyResponseCallback + ): void; + listUsable( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$Listusable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendbuckets$Listusable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendbuckets$Listusable; + 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}/regions/{region}/backendBuckets/listUsable' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionbackendbuckets$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Regionbackendbuckets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionbackendbuckets$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionbackendbuckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionbackendbuckets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendbuckets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendbuckets$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/alpha/projects/{project}/regions/{region}/backendBuckets/{backendBucket}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'backendBucket'], + pathParams: ['backendBucket', 'project', 'region'], + 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionbackendbuckets$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Regionbackendbuckets$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Regionbackendbuckets$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regionbackendbuckets$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regionbackendbuckets$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendbuckets$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendbuckets$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', '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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regionbackendbuckets$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Regionbackendbuckets$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regionbackendbuckets$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionbackendbuckets$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regionbackendbuckets$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regionbackendbuckets$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendbuckets$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendbuckets$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionbackendbuckets$Delete + extends StandardParameters { + /** + * Name of the BackendBucket resource to delete. + */ + backendBucket?: string; + /** + * Force delete the backend bucket even if it is still in use by other resources. It's intended to be used internally only for requests from wipeout. + */ + forceDelete?: boolean; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping 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). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + } + export interface Params$Resource$Regionbackendbuckets$Get + extends StandardParameters { + /** + * Name of the BackendBucket resource to return. + */ + backendBucket?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionbackendbuckets$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } + export interface Params$Resource$Regionbackendbuckets$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region of 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; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendBucket; + } + export interface Params$Resource$Regionbackendbuckets$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; + /** + * Name of the region of 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; + } + export interface Params$Resource$Regionbackendbuckets$Listusable + 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 scoping this request. It must be a string that meets the requirements in RFC1035. + */ + 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; + } + export interface Params$Resource$Regionbackendbuckets$Patch + extends StandardParameters { + /** + * Name of the BackendBucket resource to patch. + */ + backendBucket?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping 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). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackendBucket; + } + export interface Params$Resource$Regionbackendbuckets$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regionbackendbuckets$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + export class Resource$Regionbackendservices { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 8741a2ef12..1a491c01cd 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -170,6 +170,7 @@ export namespace compute_beta { nodeTypes: Resource$Nodetypes; organizationSecurityPolicies: Resource$Organizationsecuritypolicies; packetMirrorings: Resource$Packetmirrorings; + previewFeatures: Resource$Previewfeatures; projects: Resource$Projects; publicAdvertisedPrefixes: Resource$Publicadvertisedprefixes; publicDelegatedPrefixes: Resource$Publicdelegatedprefixes; @@ -312,6 +313,7 @@ export namespace compute_beta { this.organizationSecurityPolicies = new Resource$Organizationsecuritypolicies(this.context); this.packetMirrorings = new Resource$Packetmirrorings(this.context); + this.previewFeatures = new Resource$Previewfeatures(this.context); this.projects = new Resource$Projects(this.context); this.publicAdvertisedPrefixes = new Resource$Publicadvertisedprefixes( this.context @@ -1888,7 +1890,7 @@ export namespace compute_beta { */ name?: string | null; /** - * The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL. + * The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL, or when the load balancing scheme is set to EXTERNAL and haPolicy fastIpMove is enabled. */ network?: string | null; /** @@ -2677,6 +2679,19 @@ export namespace compute_beta { */ targetVmCount?: number | null; } + export interface Schema$BulkSetLabelsRequest { + /** + * The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You may optionally provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. + */ + labelFingerprint?: string | null; + /** + * The labels to set for this resource. + */ + labels?: {[key: string]: string} | null; + } + export interface Schema$BulkZoneSetLabelsRequest { + requests?: Schema$BulkSetLabelsRequest[]; + } export interface Schema$BundledLocalSsds { /** * The default disk interface if the interface is not specified. @@ -3195,6 +3210,23 @@ export namespace compute_beta { */ path?: 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$Date { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } /** * Deprecation status for a public resource. */ @@ -4395,6 +4427,10 @@ export namespace compute_beta { * Network scope of the traffic destination. */ destNetworkScope?: string | null; + /** + * Network type of the traffic destination. Allowed values are: - UNSPECIFIED - INTERNET - NON_INTERNET + */ + destNetworkType?: string | null; /** * Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. */ @@ -4427,6 +4463,10 @@ export namespace compute_beta { * Network scope of the traffic source. */ srcNetworkScope?: string | null; + /** + * Network type of the traffic source. Allowed values are: - UNSPECIFIED - INTERNET - INTRA_VPC - NON_INTERNET - VPC_NETWORKS + */ + srcNetworkType?: string | null; /** * Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. */ @@ -7036,6 +7076,10 @@ export namespace compute_beta { * The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. */ targetSize?: number | null; + /** + * The policy that specifies how the MIG creates its VMs to achieve the target size. + */ + targetSizePolicy?: Schema$InstanceGroupManagerTargetSizePolicy; /** * The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. */ @@ -7597,6 +7641,10 @@ export namespace compute_beta { * [Output Only] The URL of the Autoscaler that targets this instance group manager. */ autoscaler?: string | null; + /** + * [Output Only] The status of bulk instance operation. + */ + bulkInstanceOperation?: Schema$InstanceGroupManagerStatusBulkInstanceOperation; /** * [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. */ @@ -7620,6 +7668,41 @@ export namespace compute_beta { */ effective?: boolean | null; } + /** + * Bulk instance operation is the creation of VMs in a MIG when the targetSizePolicy.mode is set to BULK. + */ + export interface Schema$InstanceGroupManagerStatusBulkInstanceOperation { + /** + * [Output Only] Informs whether bulk instance operation is in progress. + */ + inProgress?: boolean | null; + /** + * [Output Only] Information from the last progress check of bulk instance operation. + */ + lastProgressCheck?: Schema$InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck; + } + export interface Schema$InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck { + /** + * [Output Only] Errors encountered during bulk instance operation. + */ + error?: { + errors?: Array<{ + code?: string; + errorDetails?: Array<{ + errorInfo?: Schema$ErrorInfo; + help?: Schema$Help; + localizedMessage?: Schema$LocalizedMessage; + quotaInfo?: Schema$QuotaExceededInfo; + }>; + location?: string; + message?: string; + }>; + } | null; + /** + * [Output Only] Timestamp of the last progress check of bulk instance operation. Timestamp is in RFC3339 text format. + */ + timestamp?: string | null; + } export interface Schema$InstanceGroupManagerStatusStateful { /** * [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. @@ -7655,6 +7738,12 @@ export namespace compute_beta { */ perInstanceConfigs?: Schema$PerInstanceConfig[]; } + export interface Schema$InstanceGroupManagerTargetSizePolicy { + /** + * The mode of target size policy based on which the MIG creates its VMs individually or all at once. + */ + mode?: string | null; + } export interface Schema$InstanceGroupManagerUpdatePolicy { /** * The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. @@ -8738,6 +8827,22 @@ export namespace compute_beta { * Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s */ bandwidth?: string | null; + /** + * Single IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31. + */ + candidateCloudRouterIpAddress?: string | null; + /** + * Single IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126. + */ + candidateCloudRouterIpv6Address?: string | null; + /** + * Single IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment. + */ + candidateCustomerRouterIpAddress?: string | null; + /** + * Single IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment. + */ + candidateCustomerRouterIpv6Address?: string | null; /** * This field is not available. */ @@ -8823,7 +8928,7 @@ export namespace compute_beta { */ labels?: {[key: string]: string} | null; /** - * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440. + * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440. */ mtu?: number | null; /** @@ -11641,6 +11746,10 @@ export namespace compute_beta { * Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. */ fingerprint?: string | null; + /** + * Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported. + */ + igmpQuery?: string | null; /** * The prefix length of the primary internal IPv6 range. */ @@ -13529,6 +13638,143 @@ export namespace compute_beta { */ literal?: string | null; } + /** + * Represents a single Google Compute Engine preview feature. + */ + export interface Schema$PreviewFeature { + /** + * Specifies whether the feature is enabled or disabled. + */ + activationStatus?: string | null; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * [Output Only] Description of the feature. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output only] The type of the feature. Always "compute#previewFeature" for preview features. + */ + kind?: string | null; + /** + * Name of the feature. + */ + name?: string | null; + /** + * Rollout operation of the feature. + */ + rolloutOperation?: Schema$PreviewFeatureRolloutOperation; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output only] Status of the feature. + */ + status?: Schema$PreviewFeatureStatus; + } + export interface Schema$PreviewFeatureList { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PreviewFeature resources. + */ + items?: Schema$PreviewFeature[]; + /** + * [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; + } + /** + * Represents the rollout operation + */ + export interface Schema$PreviewFeatureRolloutOperation { + rolloutInput?: Schema$PreviewFeatureRolloutOperationRolloutInput; + rolloutStatus?: Schema$PreviewFeatureRolloutOperationRolloutStatus; + } + export interface Schema$PreviewFeatureRolloutOperationRolloutInput { + /** + * The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/. + */ + name?: string | null; + /** + * Predefined rollout plan. + */ + predefinedRolloutPlan?: string | null; + /** + * The UUID of the retry action. Only needed if this is a retry for an existing rollout. This can be used after the user canceled a rollout and want to retry it with no changes. + */ + retryUuid?: string | null; + } + export interface Schema$PreviewFeatureRolloutOperationRolloutStatus { + /** + * Output only. The ongoing rollout resources. There can be multiple ongoing rollouts for a resource. + */ + ongoingRollouts?: Schema$PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata[]; + /** + * Output only. The last completed rollout resource. This field will not be populated until the first rollout is completed. + */ + previousRollout?: Schema$PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata; + } + export interface Schema$PreviewFeatureRolloutOperationRolloutStatusRolloutMetadata { + /** + * The name of the rollout Ex. organizations//locations/global/rollouts/ Ex. folders//locations/global/rollouts/ Ex. projects//locations/global/rollouts/. + */ + rollout?: string | null; + /** + * The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/. + */ + rolloutPlan?: string | null; + /** + * The status of the rollout. + */ + status?: Schema$PreviewFeatureStatus; + } + /** + * [Output Only] The status of the feature. + */ + export interface Schema$PreviewFeatureStatus { + /** + * [Output Only] The description of the feature. + */ + description?: string | null; + releaseStatus?: Schema$PreviewFeatureStatusReleaseStatus; + } + export interface Schema$PreviewFeatureStatusReleaseStatus { + /** + * [Output Only] The stage of the feature. + */ + stage?: string | null; + /** + * Output only. The last date when a feature transitioned between ReleaseStatuses. + */ + updateDate?: Schema$Date; + } /** * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. */ @@ -28059,6 +28305,94 @@ export namespace compute_beta { } } + /** + * Sets the labels on many disks at once. To learn more about labels, read the Labeling Resources documentation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkSetLabels( + params: Params$Resource$Disks$Bulksetlabels, + options: StreamMethodOptions + ): GaxiosPromise; + bulkSetLabels( + params?: Params$Resource$Disks$Bulksetlabels, + options?: MethodOptions + ): GaxiosPromise; + bulkSetLabels( + params: Params$Resource$Disks$Bulksetlabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkSetLabels( + params: Params$Resource$Disks$Bulksetlabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkSetLabels( + params: Params$Resource$Disks$Bulksetlabels, + callback: BodyResponseCallback + ): void; + bulkSetLabels(callback: BodyResponseCallback): void; + bulkSetLabels( + paramsOrCallback?: + | Params$Resource$Disks$Bulksetlabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Disks$Bulksetlabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Disks$Bulksetlabels; + 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}/disks/bulkSetLabels' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project. * @@ -29464,6 +29798,30 @@ export namespace compute_beta { */ requestBody?: Schema$BulkInsertDiskResource; } + export interface Params$Resource$Disks$Bulksetlabels + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkZoneSetLabelsRequest; + } export interface Params$Resource$Disks$Createsnapshot extends StandardParameters { /** @@ -75714,6 +76072,339 @@ export namespace compute_beta { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Previewfeatures { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the details of the given PreviewFeature. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Previewfeatures$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Previewfeatures$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Previewfeatures$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Previewfeatures$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Previewfeatures$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Previewfeatures$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Previewfeatures$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Previewfeatures$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/previewFeatures/{previewFeature}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'previewFeature'], + pathParams: ['previewFeature', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the details of the given PreviewFeature. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Previewfeatures$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Previewfeatures$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Previewfeatures$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Previewfeatures$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Previewfeatures$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Previewfeatures$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Previewfeatures$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Previewfeatures$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/previewFeatures' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Previewfeatures$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Previewfeatures$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Previewfeatures$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Previewfeatures$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Previewfeatures$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Previewfeatures$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Previewfeatures$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Previewfeatures$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/previewFeatures/{previewFeature}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'previewFeature'], + pathParams: ['previewFeature', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Previewfeatures$Get + extends StandardParameters { + /** + * Name of the PreviewFeature for this request. + */ + previewFeature?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Previewfeatures$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 interface Params$Resource$Previewfeatures$Update + extends StandardParameters { + /** + * Name of the PreviewFeature for this request. + */ + previewFeature?: 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; + + /** + * Request body metadata + */ + requestBody?: Schema$PreviewFeature; + } + export class Resource$Projects { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 8a9c9fd029..59a3d404a8 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -1786,7 +1786,7 @@ export namespace compute_v1 { */ name?: string | null; /** - * The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL. + * The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set to INTERNAL, or when the load balancing scheme is set to EXTERNAL and haPolicy fastIpMove is enabled. */ network?: string | null; /** @@ -3743,6 +3743,10 @@ export namespace compute_v1 { * URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default */ network?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$FirewallParams; /** * Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. */ @@ -3818,6 +3822,15 @@ export namespace compute_v1 { */ metadata?: string | null; } + /** + * Additional firewall parameters. + */ + export interface Schema$FirewallParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } export interface Schema$FirewallPoliciesListAssociationsResponse { /** * A list of associations. @@ -7752,7 +7765,7 @@ export namespace compute_v1 { */ labels?: {[key: string]: string} | null; /** - * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440. + * Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440. */ mtu?: number | null; /** @@ -13980,6 +13993,10 @@ export namespace compute_v1 { * The URL to a VpnTunnel that should handle matching packets. */ nextHopVpnTunnel?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$RouteParams; /** * The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. */ @@ -14052,6 +14069,15 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * Additional route parameters. + */ + export interface Schema$RouteParams { + /** + * Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : \} or Namespaced format { : \}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} * {"123/environment" : "production", "345/abc" : "xyz"\} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } export interface Schema$RoutePolicy { /** * An optional description of route policy. diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index 245f929aa2..5359526610 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -155,15 +155,15 @@ export namespace connectors_v1 { */ export interface Schema$AuthConfig { /** - * List containing additional auth configs. + * Optional. List containing additional auth configs. */ additionalVariables?: Schema$ConfigVariable[]; /** - * Identifier key for auth config + * Optional. Identifier key for auth config */ authKey?: string | null; /** - * The type of authentication configured. + * Optional. The type of authentication configured. */ authType?: string | null; /** @@ -388,7 +388,7 @@ export namespace connectors_v1 { */ intValue?: string | null; /** - * Key of the config variable. + * Optional. Key of the config variable. */ key?: string | null; /** @@ -521,6 +521,10 @@ export namespace connectors_v1 { * Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName\}/{imageName\} */ envoyImageLocation?: string | null; + /** + * Optional. Additional Oauth2.0 Auth config for EUA. If the connection is configured using non-OAuth authentication but OAuth needs to be used for EUA, this field can be populated with the OAuth config. This should be a OAuth2AuthCodeFlow Auth type only. + */ + euaOauthAuthConfig?: Schema$AuthConfig; /** * Optional. Eventing config of a connection */ @@ -533,6 +537,10 @@ export namespace connectors_v1 { * Output only. Eventing Runtime Data. */ eventingRuntimeData?: Schema$EventingRuntimeData; + /** + * Optional. Fallback on admin credentials for the connection. If this both auth_override_enabled and fallback_on_admin_credentials are set to true, the connection will use the admin credentials if the dynamic auth header is not present during auth override. + */ + fallbackOnAdminCredentials?: boolean | null; /** * Output only. The name of the Hostname of the Service Directory service with TLS. */ @@ -757,6 +765,10 @@ export namespace connectors_v1 { * Indicate whether connector is being migrated to TLS. */ migrateTls?: boolean | null; + /** + * Indicate whether connector is being migrated to use direct VPC egress. + */ + networkEgressMode?: string | null; /** * Indicate whether cloud spanner is required for connector job. */ @@ -787,7 +799,7 @@ export namespace connectors_v1 { */ export interface Schema$ConnectorsLogConfig { /** - * Enabled represents whether logging is enabled or not for a connection. + * Optional. Enabled represents whether logging is enabled or not for a connection. */ enabled?: boolean | null; /** @@ -855,6 +867,10 @@ export namespace connectors_v1 { * Output only. Resource name of the Version. Format: projects/{project\}/locations/{location\}/providers/{provider\}/connectors/{connector\}/versions/{version\} Only global location is supported for Connector resource. */ name?: string | null; + /** + * Optional. The priority entity types for the connector version. + */ + priorityEntityTypes?: Schema$PriorityEntityType[]; /** * Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha". */ @@ -1242,7 +1258,7 @@ export namespace connectors_v1 { */ export interface Schema$EncryptionKey { /** - * The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/x/locations/x/keyRings/x/cryptoKeys/x`. Will be empty string if google managed. + * Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/x/locations/x/keyRings/x/cryptoKeys/x`. Will be empty string if google managed. */ kmsKeyName?: string | null; /** @@ -1255,11 +1271,11 @@ export namespace connectors_v1 { */ export interface Schema$EndPoint { /** - * The URI of the Endpoint. + * Optional. The URI of the Endpoint. */ endpointUri?: string | null; /** - * List of Header to be added to the Endpoint. + * Optional. List of Header to be added to the Endpoint. */ headers?: Schema$Header[]; } @@ -1304,6 +1320,316 @@ export namespace connectors_v1 { */ updateTime?: string | null; } + /** + * AuthConfig defines details of a authentication type. + */ + export interface Schema$EndUserAuthentication { + /** + * Optional. Config variables for the EndUserAuthentication. + */ + configVariables?: Schema$EndUserAuthenticationConfigVariable[]; + /** + * Output only. Created time. + */ + createTime?: string | null; + /** + * Optional. Destination configs for the EndUserAuthentication. + */ + destinationConfigs?: Schema$DestinationConfig[]; + /** + * Optional. The EndUserAuthenticationConfig for the EndUserAuthentication. + */ + endUserAuthenticationConfig?: Schema$EndUserAuthenticationConfig; + /** + * Optional. Labels for the EndUserAuthentication. + */ + labels?: string[] | null; + /** + * Required. Identifier. Resource name of the EndUserAuthentication. Format: projects/{project\}/locations/{location\}/connections/{connection\}/endUserAuthentications/{end_user_authentication\} + */ + name?: string | null; + /** + * Optional. The destination to hit when we receive an event + */ + notifyEndpointDestination?: Schema$EndUserAuthenticationNotifyEndpointDestination; + /** + * Optional. Roles for the EndUserAuthentication. + */ + roles?: string[] | null; + /** + * Optional. Status of the EndUserAuthentication. + */ + status?: Schema$EndUserAuthenticationEndUserAuthenticationStatus; + /** + * Output only. Updated time. + */ + updateTime?: string | null; + /** + * Optional. The user id of the user. + */ + userId?: string | null; + } + /** + * EndUserAuthenticationConfig defines details of a authentication configuration for EUC + */ + export interface Schema$EndUserAuthenticationConfig { + /** + * Optional. List containing additional auth configs. + */ + additionalVariables?: Schema$EndUserAuthenticationConfigVariable[]; + /** + * Identifier key for auth config + */ + authKey?: string | null; + /** + * The type of authentication configured. + */ + authType?: string | null; + /** + * Oauth2AuthCodeFlow. + */ + oauth2AuthCodeFlow?: Schema$EndUserAuthenticationConfigOauth2AuthCodeFlow; + /** + * Oauth2AuthCodeFlowGoogleManaged. + */ + oauth2AuthCodeFlowGoogleManaged?: Schema$EndUserAuthenticationConfigOauth2AuthCodeFlowGoogleManaged; + /** + * Oauth2ClientCredentials. + */ + oauth2ClientCredentials?: Schema$EndUserAuthenticationConfigOauth2ClientCredentials; + /** + * Oauth2JwtBearer. + */ + oauth2JwtBearer?: Schema$EndUserAuthenticationConfigOauth2JwtBearer; + /** + * SSH Public Key. + */ + sshPublicKey?: Schema$EndUserAuthenticationConfigSshPublicKey; + /** + * UserPassword. + */ + userPassword?: Schema$EndUserAuthenticationConfigUserPassword; + } + /** + * Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. + */ + export interface Schema$EndUserAuthenticationConfigOauth2AuthCodeFlow { + /** + * Optional. Authorization code to be exchanged for access and refresh tokens. + */ + authCode?: string | null; + /** + * Optional. Auth URL for Authorization Code Flow + */ + authUri?: string | null; + /** + * Optional. Client ID for user-provided OAuth app. + */ + clientId?: string | null; + /** + * Optional. Client secret for user-provided OAuth app. + */ + clientSecret?: Schema$EUASecret; + /** + * Optional. Whether to enable PKCE when the user performs the auth code flow. + */ + enablePkce?: boolean | null; + /** + * Optional. Auth Code Data + */ + oauthTokenData?: Schema$OAuthTokenData; + /** + * Optional. PKCE verifier to be used during the auth code exchange. + */ + pkceVerifier?: string | null; + /** + * Optional. Redirect URI to be provided during the auth code exchange. + */ + redirectUri?: string | null; + /** + * Optional. Scopes the connection will request when the user performs the auth code flow. + */ + scopes?: string[] | null; + } + /** + * Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. + */ + export interface Schema$EndUserAuthenticationConfigOauth2AuthCodeFlowGoogleManaged { + /** + * Optional. Authorization code to be exchanged for access and refresh tokens. + */ + authCode?: string | null; + /** + * Auth Code Data + */ + oauthTokenData?: Schema$OAuthTokenData; + /** + * Optional. Redirect URI to be provided during the auth code exchange. + */ + redirectUri?: string | null; + /** + * Required. Scopes the connection will request when the user performs the auth code flow. + */ + scopes?: string[] | null; + } + /** + * Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. + */ + export interface Schema$EndUserAuthenticationConfigOauth2ClientCredentials { + /** + * The client identifier. + */ + clientId?: string | null; + /** + * Required. string value or secret version containing the client secret. + */ + clientSecret?: Schema$EUASecret; + } + /** + * Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. + */ + export interface Schema$EndUserAuthenticationConfigOauth2JwtBearer { + /** + * Required. secret version/value reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/x/strings/x/versions/x`. + */ + clientKey?: Schema$EUASecret; + /** + * JwtClaims providers fields to generate the token. + */ + jwtClaims?: Schema$EndUserAuthenticationConfigOauth2JwtBearerJwtClaims; + } + /** + * JWT claims used for the jwt-bearer authorization grant. + */ + export interface Schema$EndUserAuthenticationConfigOauth2JwtBearerJwtClaims { + /** + * Value for the "aud" claim. + */ + audience?: string | null; + /** + * Value for the "iss" claim. + */ + issuer?: string | null; + /** + * Value for the "sub" claim. + */ + subject?: string | null; + } + /** + * Parameters to support Ssh public key Authentication. + */ + export interface Schema$EndUserAuthenticationConfigSshPublicKey { + /** + * Format of SSH Client cert. + */ + certType?: string | null; + /** + * Required. SSH Client Cert. It should contain both public and private key. + */ + sshClientCert?: Schema$EUASecret; + /** + * Required. Password (passphrase) for ssh client certificate if it has one. + */ + sshClientCertPass?: Schema$EUASecret; + /** + * The user account used to authenticate. + */ + username?: string | null; + } + /** + * Parameters to support Username and Password Authentication. + */ + export interface Schema$EndUserAuthenticationConfigUserPassword { + /** + * Required. string value or secret version reference containing the password. + */ + password?: Schema$EUASecret; + /** + * Username. + */ + username?: string | null; + } + /** + * EndUserAuthenticationConfigVariable represents a configuration variable present in a EndUserAuthentication. + */ + export interface Schema$EndUserAuthenticationConfigVariable { + /** + * Value is a bool. + */ + boolValue?: boolean | null; + /** + * Value is an integer + */ + intValue?: string | null; + /** + * Required. Key of the config variable. + */ + key?: string | null; + /** + * Value is a secret + */ + secretValue?: Schema$EUASecret; + /** + * Value is a string. + */ + stringValue?: string | null; + } + /** + * EndUserAuthentication Status denotes the status of the EndUserAuthentication resource. + */ + export interface Schema$EndUserAuthenticationEndUserAuthenticationStatus { + /** + * Output only. Description of the state. + */ + description?: string | null; + /** + * Output only. State of Event Subscription resource. + */ + state?: string | null; + } + /** + * Message for NotifyEndpointDestination Destination to hit when the refresh token is expired. + */ + export interface Schema$EndUserAuthenticationNotifyEndpointDestination { + /** + * Optional. OPTION 1: Hit an endpoint when the refresh token is expired. + */ + endpoint?: Schema$EndUserAuthenticationNotifyEndpointDestinationEndPoint; + /** + * Required. Service account needed for runtime plane to notify the backend. + */ + serviceAccount?: string | null; + /** + * Required. type of the destination + */ + type?: string | null; + } + /** + * Endpoint message includes details of the Destination endpoint. + */ + export interface Schema$EndUserAuthenticationNotifyEndpointDestinationEndPoint { + /** + * Required. The URI of the Endpoint. + */ + endpointUri?: string | null; + /** + * Optional. List of Header to be added to the Endpoint. + */ + headers?: Schema$EndUserAuthenticationNotifyEndpointDestinationEndPointHeader[]; + } + /** + * Header details for a given header to be added to Endpoint. + */ + export interface Schema$EndUserAuthenticationNotifyEndpointDestinationEndPointHeader { + /** + * Required. Key of Header. + */ + key?: string | null; + /** + * Required. Value of Header. + */ + value?: string | null; + } /** * Data enrichment configuration. */ @@ -1326,6 +1652,19 @@ export namespace connectors_v1 { */ id?: string | null; } + /** + * EUASecret provides a reference to entries in Secret Manager. + */ + export interface Schema$EUASecret { + /** + * Optional. The plain string value of the secret. + */ + secretValue?: string | null; + /** + * Optional. The resource name of the secret version in the format, format as: `projects/x/secrets/x/versions/x`. + */ + secretVersion?: string | null; + } /** * Eventing Configuration of a connection next: 18 */ @@ -1528,7 +1867,7 @@ export namespace connectors_v1 { */ jms?: Schema$JMS; /** - * Required. Resource name of the EventSubscription. Format: projects/{project\}/locations/{location\}/connections/{connection\}/eventSubscriptions/{event_subscription\} + * Required. Identifier. Resource name of the EventSubscription. Format: projects/{project\}/locations/{location\}/connections/{connection\}/eventSubscriptions/{event_subscription\} */ name?: string | null; /** @@ -1565,11 +1904,11 @@ export namespace connectors_v1 { */ pubsub?: Schema$PubSub; /** - * Service account needed for runtime plane to trigger IP workflow. + * Optional. Service account needed for runtime plane to trigger IP workflow. */ serviceAccount?: string | null; /** - * type of the destination + * Optional. type of the destination */ type?: string | null; } @@ -1750,11 +2089,11 @@ export namespace connectors_v1 { */ export interface Schema$Header { /** - * Key of Header. + * Optional. Key of Header. */ key?: string | null; /** - * Value of Header. + * Optional. Value of Header. */ value?: string | null; } @@ -1955,15 +2294,15 @@ export namespace connectors_v1 { */ export interface Schema$JwtClaims { /** - * Value for the "aud" claim. + * Optional. Value for the "aud" claim. */ audience?: string | null; /** - * Value for the "iss" claim. + * Optional. Value for the "iss" claim. */ issuer?: string | null; /** - * Value for the "sub" claim. + * Optional. Value for the "sub" claim. */ subject?: string | null; } @@ -2082,6 +2421,23 @@ export namespace connectors_v1 { */ unreachable?: string[] | null; } + /** + * Response message for ConnectorsService.ListEndUserAuthentications + */ + export interface Schema$ListEndUserAuthenticationsResponse { + /** + * Subscriptions. + */ + endUserAuthentications?: Schema$EndUserAuthentication[]; + /** + * Next page token. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Expected request for ListenEvent API. */ @@ -2254,11 +2610,11 @@ export namespace connectors_v1 { */ export interface Schema$LockConfig { /** - * Indicates whether or not the connection is locked. + * Optional. Indicates whether or not the connection is locked. */ locked?: boolean | null; /** - * Describes why a connection is locked. + * Optional. Describes why a connection is locked. */ reason?: string | null; } @@ -2481,11 +2837,11 @@ export namespace connectors_v1 { */ export interface Schema$NodeConfig { /** - * Maximum number of nodes in the runtime nodes. + * Optional. Maximum number of nodes in the runtime nodes. */ maxNodeCount?: number | null; /** - * Minimum number of nodes in the runtime nodes. + * Optional. Minimum number of nodes in the runtime nodes. */ minNodeCount?: number | null; } @@ -2520,35 +2876,35 @@ export namespace connectors_v1 { */ export interface Schema$Oauth2AuthCodeFlow { /** - * Authorization code to be exchanged for access and refresh tokens. + * Optional. Authorization code to be exchanged for access and refresh tokens. */ authCode?: string | null; /** - * Auth URL for Authorization Code Flow + * Optional. Auth URL for Authorization Code Flow */ authUri?: string | null; /** - * Client ID for user-provided OAuth app. + * Optional. Client ID for user-provided OAuth app. */ clientId?: string | null; /** - * Client secret for user-provided OAuth app. + * Optional. Client secret for user-provided OAuth app. */ clientSecret?: Schema$Secret; /** - * Whether to enable PKCE when the user performs the auth code flow. + * Optional. Whether to enable PKCE when the user performs the auth code flow. */ enablePkce?: boolean | null; /** - * PKCE verifier to be used during the auth code exchange. + * Optional. PKCE verifier to be used during the auth code exchange. */ pkceVerifier?: string | null; /** - * Redirect URI to be provided during the auth code exchange. + * Optional. Redirect URI to be provided during the auth code exchange. */ redirectUri?: string | null; /** - * Scopes the connection will request when the user performs the auth code flow. + * Optional. Scopes the connection will request when the user performs the auth code flow. */ scopes?: string[] | null; } @@ -2574,11 +2930,11 @@ export namespace connectors_v1 { */ export interface Schema$Oauth2ClientCredentials { /** - * The client identifier. + * Optional. The client identifier. */ clientId?: string | null; /** - * Secret version reference containing the client secret. + * Optional. Secret version reference containing the client secret. */ clientSecret?: Schema$Secret; } @@ -2587,14 +2943,35 @@ export namespace connectors_v1 { */ export interface Schema$Oauth2JwtBearer { /** - * Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/x/secrets/x/versions/x`. + * Optional. Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/x/secrets/x/versions/x`. */ clientKey?: Schema$Secret; /** - * JwtClaims providers fields to generate the token. + * Optional. JwtClaims providers fields to generate the token. */ jwtClaims?: Schema$JwtClaims; } + /** + * pass only at create and not update using updateMask Auth Code Data + */ + export interface Schema$OAuthTokenData { + /** + * Optional. Access token for the connection. + */ + accessToken?: Schema$EUASecret; + /** + * Optional. Timestamp when the access token was created. + */ + createTime?: string | null; + /** + * Optional. Time in seconds when the access token expires. + */ + expiry?: string | null; + /** + * Optional. Refresh token for the connection. + */ + refreshToken?: Schema$EUASecret; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -2756,6 +3133,27 @@ export namespace connectors_v1 { */ version?: number | null; } + /** + * PriorityEntityType represents an entity type with its associated priority and order. + */ + export interface Schema$PriorityEntityType { + /** + * The description of the entity type. + */ + description?: string | null; + /** + * The entity type. + */ + id?: string | null; + /** + * The order of the entity type within its priority group. + */ + order?: number | null; + /** + * The priority of the entity type, such as P0, P1, etc. + */ + priority?: string | null; + } /** * Provider indicates the owner who provides the connectors. */ @@ -3163,7 +3561,7 @@ export namespace connectors_v1 { */ export interface Schema$Secret { /** - * The resource name of the secret version in the format, format as: `projects/x/secrets/x/versions/x`. + * Optional. The resource name of the secret version in the format, format as: `projects/x/secrets/x/versions/x`. */ secretVersion?: string | null; } @@ -3249,19 +3647,19 @@ export namespace connectors_v1 { */ export interface Schema$SshPublicKey { /** - * Format of SSH Client cert. + * Optional. Format of SSH Client cert. */ certType?: string | null; /** - * SSH Client Cert. It should contain both public and private key. + * Optional. SSH Client Cert. It should contain both public and private key. */ sshClientCert?: Schema$Secret; /** - * Password (passphrase) for ssh client certificate if it has one. + * Optional. Password (passphrase) for ssh client certificate if it has one. */ sshClientCertPass?: Schema$Secret; /** - * The user account used to authenticate. + * Optional. The user account used to authenticate. */ username?: string | null; } @@ -3465,11 +3863,11 @@ export namespace connectors_v1 { */ export interface Schema$UserPassword { /** - * Secret version reference containing the password. + * Optional. Secret version reference containing the password. */ password?: Schema$Secret; /** - * Username. + * Optional. Username. */ username?: string | null; } @@ -4090,6 +4488,7 @@ export namespace connectors_v1 { export class Resource$Projects$Locations$Connections { context: APIRequestContext; connectionSchemaMetadata: Resource$Projects$Locations$Connections$Connectionschemametadata; + endUserAuthentications: Resource$Projects$Locations$Connections$Enduserauthentications; eventSubscriptions: Resource$Projects$Locations$Connections$Eventsubscriptions; runtimeActionSchemas: Resource$Projects$Locations$Connections$Runtimeactionschemas; runtimeEntitySchemas: Resource$Projects$Locations$Connections$Runtimeentityschemas; @@ -4099,6 +4498,10 @@ export namespace connectors_v1 { new Resource$Projects$Locations$Connections$Connectionschemametadata( this.context ); + this.endUserAuthentications = + new Resource$Projects$Locations$Connections$Enduserauthentications( + this.context + ); this.eventSubscriptions = new Resource$Projects$Locations$Connections$Eventsubscriptions( this.context @@ -5290,7 +5693,7 @@ export namespace connectors_v1 { */ name?: string; /** - * Required. You can modify only the fields listed below. To lock/unlock a connection: * `lock_config` To suspend/resume a connection: * `suspended` To update the connection details: * `description` * `labels` * `connector_version` * `config_variables` * `auth_config` * `destination_configs` * `node_config` * `log_config` * `ssl_config` * `eventing_enablement_type` * `eventing_config` * `auth_override_enabled` + * Required. The list of fields to update. Fields are specified relative to the connection. A field will be overwritten if it is in the mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. You can modify only the fields listed below. To lock/unlock a connection: * `lock_config` To suspend/resume a connection: * `suspended` To update the connection details: * `description` * `labels` * `connector_version` * `config_variables` * `auth_config` * `destination_configs` * `node_config` * `log_config` * `ssl_config` * `eventing_enablement_type` * `eventing_config` * `auth_override_enabled` */ updateMask?: string; @@ -5314,87 +5717,632 @@ export namespace connectors_v1 { export interface Params$Resource$Projects$Locations$Connections$Search extends StandardParameters { /** - * Required. Parent resource of the Connection, of the form: `projects/x/locations/x/connections` + * Required. Parent resource of the Connection, of the form: `projects/x/locations/x/connections` + */ + name?: string; + /** + * Optional. The number of top matching connectors to return + */ + pageSize?: number; + /** + * Optional. page_token + */ + pageToken?: string; + /** + * Required. The query against which the search needs to be done. + */ + query?: string; + } + export interface Params$Resource$Projects$Locations$Connections$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Connections$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Connections$Connectionschemametadata { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get action. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAction( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + options: StreamMethodOptions + ): GaxiosPromise; + getAction( + params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + options?: MethodOptions + ): GaxiosPromise; + getAction( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAction( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAction( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + callback: BodyResponseCallback + ): void; + getAction(callback: BodyResponseCallback): void; + getAction( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction; + 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}:getAction').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get entity type. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getEntityType( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + options: StreamMethodOptions + ): GaxiosPromise; + getEntityType( + params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + options?: MethodOptions + ): GaxiosPromise; + getEntityType( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEntityType( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEntityType( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + callback: BodyResponseCallback + ): void; + getEntityType(callback: BodyResponseCallback): void; + getEntityType( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype; + 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}:getEntityType').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List actions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listActions( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, + options: StreamMethodOptions + ): GaxiosPromise; + listActions( + params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, + options?: MethodOptions + ): GaxiosPromise; + listActions( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listActions( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listActions( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, + callback: BodyResponseCallback + ): void; + listActions( + callback: BodyResponseCallback + ): void; + listActions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions; + 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}:listActions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List entity types. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listEntityTypes( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, + options: StreamMethodOptions + ): GaxiosPromise; + listEntityTypes( + params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, + options?: MethodOptions + ): GaxiosPromise; + listEntityTypes( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listEntityTypes( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listEntityTypes( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, + callback: BodyResponseCallback + ): void; + listEntityTypes( + callback: BodyResponseCallback + ): void; + listEntityTypes( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes; + 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}:listEntityTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Refresh runtime schema of a connection. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + refresh( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + options: StreamMethodOptions + ): GaxiosPromise; + refresh( + params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + options?: MethodOptions + ): GaxiosPromise; + refresh( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + refresh( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + refresh( + params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + callback: BodyResponseCallback + ): void; + refresh(callback: BodyResponseCallback): void; + refresh( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh; + 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}:refresh').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction + extends StandardParameters { + /** + * Required. Id of the action. + */ + actionId?: string; + /** + * Required. Resource name format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype + extends StandardParameters { + /** + * Required. Id of the entity type. + */ + entityId?: string; + /** + * Required. Resource name format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions + extends StandardParameters { + /** + * Required. Filter Wildcards are not supported in the filter currently. + */ + filter?: string; + /** + * Required. Resource name format. projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata + */ + name?: string; + /** + * Page size. If unspecified, at most 50 actions will be returned. + */ + pageSize?: number; + /** + * Page token. + */ + pageToken?: string; + /** + * Specifies which fields are returned in response. Defaults to BASIC view. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes + extends StandardParameters { + /** + * Required. Filter Wildcards are not supported in the filter currently. + */ + filter?: string; + /** + * Required. Resource name format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata */ name?: string; /** - * Optional. The number of top matching connectors to return + * Page size. If unspecified, at most 50 entity types will be returned. */ pageSize?: number; /** - * Optional. page_token + * Page token. */ pageToken?: string; /** - * Required. The query against which the search needs to be done. - */ - query?: string; - } - export interface Params$Resource$Projects$Locations$Connections$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 + * Specifies which fields are returned in response. Defaults to BASIC view. */ - requestBody?: Schema$SetIamPolicyRequest; + view?: string; } - export interface Params$Resource$Projects$Locations$Connections$Testiampermissions + export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh 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. + * Required. Resource name. Format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata */ - resource?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$RefreshConnectionSchemaMetadataRequest; } - export class Resource$Projects$Locations$Connections$Connectionschemametadata { + export class Resource$Projects$Locations$Connections$Enduserauthentications { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Get action. + * Creates a new EndUserAuthentication in a given project,location and connection. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getAction( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + create( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Create, options: StreamMethodOptions ): GaxiosPromise; - getAction( - params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + create( + params?: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Create, options?: MethodOptions ): GaxiosPromise; - getAction( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + create( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getAction( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + create( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getAction( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction, + create( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Create, callback: BodyResponseCallback ): void; - getAction(callback: BodyResponseCallback): void; - getAction( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction + | Params$Resource$Projects$Locations$Connections$Enduserauthentications$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5407,13 +6355,13 @@ export namespace connectors_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction; + {}) as Params$Resource$Projects$Locations$Connections$Enduserauthentications$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction; + {} as Params$Resource$Projects$Locations$Connections$Enduserauthentications$Create; options = {}; } @@ -5426,18 +6374,18 @@ export namespace connectors_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:getAction').replace( + url: (rootUrl + '/v1/{+parent}/endUserAuthentications').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -5451,39 +6399,39 @@ export namespace connectors_v1 { } /** - * Get entity type. + * Deletes a single EndUserAuthentication. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getEntityType( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + delete( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Delete, options: StreamMethodOptions ): GaxiosPromise; - getEntityType( - params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + delete( + params?: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Delete, options?: MethodOptions ): GaxiosPromise; - getEntityType( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + delete( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getEntityType( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + delete( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getEntityType( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype, + delete( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Delete, callback: BodyResponseCallback ): void; - getEntityType(callback: BodyResponseCallback): void; - getEntityType( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype + | Params$Resource$Projects$Locations$Connections$Enduserauthentications$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5496,13 +6444,13 @@ export namespace connectors_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype; + {}) as Params$Resource$Projects$Locations$Connections$Enduserauthentications$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype; + {} as Params$Resource$Projects$Locations$Connections$Enduserauthentications$Delete; options = {}; } @@ -5515,11 +6463,8 @@ export namespace connectors_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:getEntityType').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -5540,63 +6485,63 @@ export namespace connectors_v1 { } /** - * List actions. + * Gets details of a single EndUserAuthentication. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listActions( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, + get( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Get, options: StreamMethodOptions ): GaxiosPromise; - listActions( - params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, + get( + params?: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Get, options?: MethodOptions - ): GaxiosPromise; - listActions( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listActions( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listActions( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listActions( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Get, + callback: BodyResponseCallback ): void; - listActions( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Connections$Enduserauthentications$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$Connections$Connectionschemametadata$Listactions; + {}) as Params$Resource$Projects$Locations$Connections$Enduserauthentications$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions; + {} as Params$Resource$Projects$Locations$Connections$Enduserauthentications$Get; options = {}; } @@ -5609,10 +6554,7 @@ export namespace connectors_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:listActions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -5624,75 +6566,75 @@ export namespace connectors_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * List entity types. + * List EndUserAuthentications in a given project,location and connection. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listEntityTypes( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, + list( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$List, options: StreamMethodOptions ): GaxiosPromise; - listEntityTypes( - params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, + list( + params?: Params$Resource$Projects$Locations$Connections$Enduserauthentications$List, options?: MethodOptions - ): GaxiosPromise; - listEntityTypes( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listEntityTypes( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, + list( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listEntityTypes( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$List, + callback: BodyResponseCallback ): void; - listEntityTypes( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - listEntityTypes( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes - | BodyResponseCallback + | Params$Resource$Projects$Locations$Connections$Enduserauthentications$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$Connections$Connectionschemametadata$Listentitytypes; + {}) as Params$Resource$Projects$Locations$Connections$Enduserauthentications$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes; + {} as Params$Resource$Projects$Locations$Connections$Enduserauthentications$List; options = {}; } @@ -5705,7 +6647,7 @@ export namespace connectors_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:listEntityTypes').replace( + url: (rootUrl + '/v1/{+parent}/endUserAuthentications').replace( /([^:]\/)\/+/g, '$1' ), @@ -5715,54 +6657,56 @@ export namespace connectors_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Refresh runtime schema of a connection. + * Updates the parameters of a single EndUserAuthentication. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - refresh( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + patch( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Patch, options: StreamMethodOptions ): GaxiosPromise; - refresh( - params?: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + patch( + params?: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Patch, options?: MethodOptions ): GaxiosPromise; - refresh( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + patch( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - refresh( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + patch( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - refresh( - params: Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh, + patch( + params: Params$Resource$Projects$Locations$Connections$Enduserauthentications$Patch, callback: BodyResponseCallback ): void; - refresh(callback: BodyResponseCallback): void; - refresh( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh + | Params$Resource$Projects$Locations$Connections$Enduserauthentications$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5775,13 +6719,13 @@ export namespace connectors_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh; + {}) as Params$Resource$Projects$Locations$Connections$Enduserauthentications$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh; + {} as Params$Resource$Projects$Locations$Connections$Enduserauthentications$Patch; options = {}; } @@ -5794,11 +6738,8 @@ export namespace connectors_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:refresh').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -5819,63 +6760,52 @@ export namespace connectors_v1 { } } - export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getaction + export interface Params$Resource$Projects$Locations$Connections$Enduserauthentications$Create extends StandardParameters { /** - * Required. Id of the action. + * Required. Identifier to assign to the EndUserAuthentication. Must be unique within scope of the parent resource. */ - actionId?: string; + endUserAuthenticationId?: string; /** - * Required. Resource name format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata + * Required. Parent resource of the EndUserAuthentication, of the form: `projects/x/locations/x/connections/x` */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Getentitytype - extends StandardParameters { + parent?: string; + /** - * Required. Id of the entity type. + * Request body metadata */ - entityId?: string; + requestBody?: Schema$EndUserAuthentication; + } + export interface Params$Resource$Projects$Locations$Connections$Enduserauthentications$Delete + extends StandardParameters { /** - * Required. Resource name format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata + * Required. Resource name of the form: `projects/x/locations/x/connections/x/endUserAuthentication/x` */ name?: string; } - export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listactions + export interface Params$Resource$Projects$Locations$Connections$Enduserauthentications$Get extends StandardParameters { /** - * Required. Filter Wildcards are not supported in the filter currently. - */ - filter?: string; - /** - * Required. Resource name format. projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata + * Required. Resource name of the form: `projects/x/locations/x/connections/x/EndUserAuthentications/x` */ name?: string; /** - * Page size. If unspecified, at most 50 actions will be returned. - */ - pageSize?: number; - /** - * Page token. - */ - pageToken?: string; - /** - * Specifies which fields are returned in response. Defaults to BASIC view. + * Optional. View of the EndUserAuthentication to return. */ view?: string; } - export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Listentitytypes + export interface Params$Resource$Projects$Locations$Connections$Enduserauthentications$List extends StandardParameters { /** - * Required. Filter Wildcards are not supported in the filter currently. + * Filter. */ filter?: string; /** - * Required. Resource name format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata + * Order by parameters. */ - name?: string; + orderBy?: string; /** - * Page size. If unspecified, at most 50 entity types will be returned. + * Page size. */ pageSize?: number; /** @@ -5883,21 +6813,25 @@ export namespace connectors_v1 { */ pageToken?: string; /** - * Specifies which fields are returned in response. Defaults to BASIC view. + * Required. Parent resource of the EndUserAuthentication, of the form: `projects/x/locations/x/connections/x` */ - view?: string; + parent?: string; } - export interface Params$Resource$Projects$Locations$Connections$Connectionschemametadata$Refresh + export interface Params$Resource$Projects$Locations$Connections$Enduserauthentications$Patch extends StandardParameters { /** - * Required. Resource name. Format: projects/{project\}/locations/{location\}/connections/{connection\}/connectionSchemaMetadata + * Required. Identifier. Resource name of the EndUserAuthentication. Format: projects/{project\}/locations/{location\}/connections/{connection\}/endUserAuthentications/{end_user_authentication\} */ name?: string; + /** + * Required. The list of fields to update. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EndUserAuthentication details: * `notify_endpoint_destination` + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$RefreshConnectionSchemaMetadataRequest; + requestBody?: Schema$EndUserAuthentication; } export class Resource$Projects$Locations$Connections$Eventsubscriptions { @@ -6497,7 +7431,7 @@ export namespace connectors_v1 { export interface Params$Resource$Projects$Locations$Connections$Eventsubscriptions$Patch extends StandardParameters { /** - * Required. Resource name of the EventSubscription. Format: projects/{project\}/locations/{location\}/connections/{connection\}/eventSubscriptions/{event_subscription\} + * Required. Identifier. Resource name of the EventSubscription. Format: projects/{project\}/locations/{location\}/connections/{connection\}/eventSubscriptions/{event_subscription\} */ name?: string; /** @@ -10868,6 +11802,10 @@ export namespace connectors_v1 { * Required. Resource name of the form: `projects/x/locations/x/providers/x/connectors/x/versions/x` Only global location is supported for ConnectorVersion resource. */ name?: string; + /** + * Optional. Enum to control whether schema enrichment related fields should be included in the response. + */ + schemaView?: string; /** * Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `CUSTOMER` view. */ @@ -10887,6 +11825,10 @@ export namespace connectors_v1 { * Required. Parent resource of the connectors, of the form: `projects/x/locations/x/providers/x/connectors/x` Only global location is supported for ConnectorVersion resource. */ parent?: string; + /** + * Optional. Enum to control whether schema enrichment related fields should be included in the response. + */ + schemaView?: string; /** * Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `BASIC` view. */ diff --git a/src/apis/connectors/v2.ts b/src/apis/connectors/v2.ts index 2a153ae0c5..42429b759a 100644 --- a/src/apis/connectors/v2.ts +++ b/src/apis/connectors/v2.ts @@ -190,6 +190,10 @@ export namespace connectors_v2 { * OAuth redirect URI passed in during the auth code flow, required by some OAuth backends. */ redirectUri?: string | null; + /** + * Scopes the connection will request when the user performs the auth code flow. + */ + scopes?: string[] | null; } /** * Response containing status of the connector for readiness prober. diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index 919021d698..b825e3765a 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -968,6 +968,39 @@ export namespace contactcenterinsights_v1 { */ parent?: string | null; } + /** + * Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic) + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1Dataset { + /** + * Output only. Dataset create time. + */ + createTime?: string | null; + /** + * Dataset description. + */ + description?: string | null; + /** + * Display name for the dataaset + */ + displayName?: string | null; + /** + * Immutable. Identifier. Resource name of the dataset. Format: projects/{project\}/locations/{location\}/datasets/{dataset\} + */ + name?: string | null; + /** + * Optional. Option TTL for the dataset. + */ + ttl?: string | null; + /** + * Dataset usage type. + */ + type?: string | null; + /** + * Output only. Dataset update time. + */ + updateTime?: string | null; + } /** * Metadata for deleting an issue model. */ @@ -2254,6 +2287,86 @@ export namespace contactcenterinsights_v1 { */ querySource?: string | null; } + /** + * The metadata for an SampleConversations operation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadata { + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete. + */ + partialErrors?: Schema$GoogleRpcStatus[]; + /** + * Output only. The original request for sample conversations to dataset. + */ + request?: Schema$GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest; + /** + * Output only. Statistics for SampleConversations operation. + */ + sampleConversationsStats?: Schema$GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats; + } + /** + * Statistics for SampleConversations operation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1SampleConversationsMetadataSampleConversationsStats { + /** + * Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field. + */ + failedSampleCount?: number | null; + /** + * Output only. The number of new conversations added during this sample operation. + */ + successfulSampleCount?: number | null; + } + /** + * The request to sample conversations to a dataset. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1SampleConversationsRequest { + /** + * The dataset resource to copy the sampled conversations to. + */ + destinationDataset?: Schema$GoogleCloudContactcenterinsightsV1alpha1Dataset; + /** + * Required. The parent resource of the dataset. + */ + parent?: string | null; + /** + * Optional. The sample rule used for sampling conversations. + */ + sampleRule?: Schema$GoogleCloudContactcenterinsightsV1alpha1SampleRule; + } + /** + * The response to an SampleConversations operation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1SampleConversationsResponse {} + /** + * Message for sampling conversations. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1SampleRule { + /** + * To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations. + */ + conversationFilter?: string | null; + /** + * Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'. + */ + dimension?: string | null; + /** + * Percentage of conversations that we should sample based on the dimension between [0, 100]. + */ + samplePercentage?: number | null; + /** + * Number of the conversations that we should sample based on the dimension. + */ + sampleRow?: string | null; + } /** * The data for a sentiment annotation. */ @@ -2671,6 +2784,52 @@ export namespace contactcenterinsights_v1 { */ uri?: string | null; } + /** + * An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1AuthorizedView { + /** + * A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations liked to the conversation) that this AuthorizedView has. + */ + conversationFilter?: string | null; + /** + * Output only. The time at which the authorized view was created. + */ + createTime?: string | null; + /** + * Display Name. Limit 64 characters. + */ + displayName?: string | null; + /** + * Identifier. The resource name of the AuthorizedView. Format: projects/{project\}/locations/{location\}/authorizedViewSets/{authorized_view_set\}/authorizedViews/{authorized_view\} + */ + name?: string | null; + /** + * Output only. The most recent time at which the authorized view was updated. + */ + updateTime?: string | null; + } + /** + * An AuthorizedViewSet contains a set of AuthorizedView resources. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1AuthorizedViewSet { + /** + * Output only. Create time. + */ + createTime?: string | null; + /** + * Display Name. Limit 64 characters. + */ + displayName?: string | null; + /** + * Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project\}/locations/{location\}/authorizedViewSets/{authorized_view_set\} + */ + name?: string | null; + /** + * Output only. Update time. + */ + updateTime?: string | null; + } /** * The metadata for a bulk analyze conversations operation. */ @@ -2987,6 +3146,15 @@ export namespace contactcenterinsights_v1 { */ currentStats?: Schema$GoogleCloudContactcenterinsightsV1IssueModelLabelStats; } + /** + * The request for calculating conversation statistics. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1CalculateStatsRequest { + /** + * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. + */ + filter?: string | null; + } /** * The response for calculating conversation statistics. */ @@ -3519,6 +3687,39 @@ export namespace contactcenterinsights_v1 { */ parent?: string | null; } + /** + * Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic) + */ + export interface Schema$GoogleCloudContactcenterinsightsV1Dataset { + /** + * Output only. Dataset create time. + */ + createTime?: string | null; + /** + * Dataset description. + */ + description?: string | null; + /** + * Display name for the dataaset + */ + displayName?: string | null; + /** + * Immutable. Identifier. Resource name of the dataset. Format: projects/{project\}/locations/{location\}/datasets/{dataset\} + */ + name?: string | null; + /** + * Optional. Option TTL for the dataset. + */ + ttl?: string | null; + /** + * Dataset usage type. + */ + type?: string | null; + /** + * Output only. Dataset update time. + */ + updateTime?: string | null; + } /** * Metadata for deleting an issue model. */ @@ -4421,6 +4622,32 @@ export namespace contactcenterinsights_v1 { */ nextPageToken?: string | null; } + /** + * The response from a ListAuthorizedViewSet request. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1ListAuthorizedViewSetsResponse { + /** + * The AuthorizedViewSets under the parent. + */ + authorizedViewSets?: Schema$GoogleCloudContactcenterinsightsV1AuthorizedViewSet[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The response from a ListAuthorizedViews request. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1ListAuthorizedViewsResponse { + /** + * The AuthorizedViews under the parent. + */ + authorizedViews?: Schema$GoogleCloudContactcenterinsightsV1AuthorizedView[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * The response of listing conversations. */ @@ -4747,7 +4974,7 @@ export namespace contactcenterinsights_v1 { */ questionBody?: string | null; /** - * User-defined list of arbitrary tags for the question. Used for grouping/organization and for weighting the score of each question. + * Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., "BUSINESS", "COMPLIANCE", and "CUSTOMER"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project\}/locations/{location\}/qaQuestionTags/{qa_question_tag\}). Both default and custom tags are used to group questions and to influence the scoring of each question. */ tags?: string[] | null; /** @@ -5203,6 +5430,99 @@ export namespace contactcenterinsights_v1 { */ querySource?: string | null; } + /** + * The metadata for an SampleConversations operation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1SampleConversationsMetadata { + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Partial errors during sample conversations operation that might cause the operation output to be incomplete. + */ + partialErrors?: Schema$GoogleRpcStatus[]; + /** + * Output only. The original request for sample conversations to dataset. + */ + request?: Schema$GoogleCloudContactcenterinsightsV1SampleConversationsRequest; + /** + * Output only. Statistics for SampleConversations operation. + */ + sampleConversationsStats?: Schema$GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats; + } + /** + * Statistics for SampleConversations operation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1SampleConversationsMetadataSampleConversationsStats { + /** + * Output only. The number of objects which were unable to be sampled due to errors. The errors are populated in the partial_errors field. + */ + failedSampleCount?: number | null; + /** + * Output only. The number of new conversations added during this sample operation. + */ + successfulSampleCount?: number | null; + } + /** + * The request to sample conversations to a dataset. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1SampleConversationsRequest { + /** + * The dataset resource to copy the sampled conversations to. + */ + destinationDataset?: Schema$GoogleCloudContactcenterinsightsV1Dataset; + /** + * Required. The parent resource of the dataset. + */ + parent?: string | null; + /** + * Optional. The sample rule used for sampling conversations. + */ + sampleRule?: Schema$GoogleCloudContactcenterinsightsV1SampleRule; + } + /** + * The response to an SampleConversations operation. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1SampleConversationsResponse {} + /** + * Message for sampling conversations. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1SampleRule { + /** + * To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations. + */ + conversationFilter?: string | null; + /** + * Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'. + */ + dimension?: string | null; + /** + * Percentage of conversations that we should sample based on the dimension between [0, 100]. + */ + samplePercentage?: number | null; + /** + * Number of the conversations that we should sample based on the dimension. + */ + sampleRow?: string | null; + } + /** + * The response from a ListAuthorizedViews request. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1SearchAuthorizedViewsResponse { + /** + * The AuthorizedViews under the parent. + */ + authorizedViews?: Schema$GoogleCloudContactcenterinsightsV1AuthorizedView[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * The data for a sentiment annotation. */ @@ -6997,84 +7317,67 @@ export namespace contactcenterinsights_v1 { this.context ); } - } - - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews { - context: APIRequestContext; - conversations: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations; - operations: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.conversations = - new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations( - this.context - ); - this.operations = - new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations( - this.context - ); - } /** - * Query metrics. + * Create AuthorizedViewSet * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryMetrics( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Create, options: StreamMethodOptions ): GaxiosPromise; - queryMetrics( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, + create( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Create, options?: MethodOptions - ): GaxiosPromise; - queryMetrics( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryMetrics( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryMetrics( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Create, + callback: BodyResponseCallback ): void; - queryMetrics( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - queryMetrics( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$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$Authorizedviewsets$Authorizedviews$Querymetrics; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Create; options = {}; } @@ -7088,7 +7391,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+location}:queryMetrics').replace( + url: (rootUrl + '/v1/{+parent}/authorizedViewSets').replace( /([^:]\/)\/+/g, '$1' ), @@ -7098,110 +7401,78 @@ export namespace contactcenterinsights_v1 { options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics - extends StandardParameters { - /** - * Required. The location of the data. "projects/{project\}/locations/{location\}" - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1QueryMetricsRequest; - } - - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations { - context: APIRequestContext; - analyses: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses; - feedbackLabels: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels; - constructor(context: APIRequestContext) { - this.context = context; - this.analyses = - new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses( - this.context - ); - this.feedbackLabels = - new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels( - this.context + return createAPIRequest( + parameters ); + } } /** - * Analyzes multiple conversations in a single request. + * Deletes an AuthorizedViewSet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkAnalyze( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Delete, options: StreamMethodOptions ): GaxiosPromise; - bulkAnalyze( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, + delete( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Delete, options?: MethodOptions - ): GaxiosPromise; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkAnalyze( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Delete, + callback: BodyResponseCallback ): void; - bulkAnalyze( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$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$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Delete; options = {}; } @@ -7215,90 +7486,87 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets conversation statistics. + * Get AuthorizedViewSet * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - calculateStats( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Get, options: StreamMethodOptions ): GaxiosPromise; - calculateStats( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, + get( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Get, options?: MethodOptions - ): GaxiosPromise; - calculateStats( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Get, + callback: BodyResponseCallback ): void; - calculateStats( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - calculateStats( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$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$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Get; options = {}; } @@ -7312,87 +7580,89 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+location}/conversations:calculateStats' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a conversation. + * List AuthorizedViewSets * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Conversations$Delete, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, + list( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$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$Authorizedviewsets$Authorizedviews$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$List; options = {}; } @@ -7406,87 +7676,92 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/authorizedViewSets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a conversation. + * Updates an AuthorizedViewSet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, + patch( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$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$Authorizedviewsets$Authorizedviews$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Patch; options = {}; } @@ -7501,7 +7776,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -7512,198 +7787,110 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Create + extends StandardParameters { /** - * Lists conversations. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Optional. A unique ID for the new AuthorizedViewSet. This ID will become the final component of the AuthorizedViewSet's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See go/aip/122#resource-id-segments */ - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze - extends StandardParameters { + authorizedViewSetId?: string; /** - * Required. The parent resource to create analyses in. + * Required. The parent resource of the AuthorizedViewSet. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats - extends StandardParameters { - /** - * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. - */ - filter?: string; - /** - * Required. The location of the conversations. - */ - location?: string; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1AuthorizedViewSet; } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Delete extends StandardParameters { /** - * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + * Optional. If set to true, all of this AuthorizedViewSet's child resources will also be deleted. Otherwise, the request will only succeed if it has none. */ force?: boolean; /** - * Required. The name of the conversation to delete. + * Required. The name of the AuthorizedViewSet to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Get extends StandardParameters { /** - * Required. The name of the conversation to get. + * Required. The name of the AuthorizedViewSet to get. */ name?: string; - /** - * The level of details of the conversation. Default is `FULL`. - */ - view?: string; } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List + export interface Params$Resource$Projects$Locations$Authorizedviewsets$List extends StandardParameters { /** - * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + * Optional. The filter expression to filter authorized view sets listed in the response. */ filter?: string; /** - * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + * Optional. The order by expression to order authorized view sets listed in the response. */ orderBy?: string; /** - * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * Optional. The maximum number of view sets to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. */ pageSize?: number; /** - * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. + * Optional. The value returned by the last `ListAuthorizedViewSetsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViewSets` call and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the conversation. + * Required. The parent resource of the AuthorizedViewSets. */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Patch + extends StandardParameters { /** - * The level of details of the conversation. Default is `BASIC`. + * Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project\}/locations/{location\}/authorizedViewSets/{authorized_view_set\} */ - view?: string; + name?: string; + /** + * Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1AuthorizedViewSet; } - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses { + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews { context: APIRequestContext; + conversations: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations; + operations: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations; constructor(context: APIRequestContext) { this.context = context; + this.conversations = + new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations( + this.context + ); + this.operations = + new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations( + this.context + ); } /** - * Creates an analysis. The long running operation is done when the analysis has completed. + * Create AuthorizedView * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7711,57 +7898,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$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$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Create; options = {}; } @@ -7775,7 +7962,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( + url: (rootUrl + '/v1/{+parent}/authorizedViews').replace( /([^:]\/)\/+/g, '$1' ), @@ -7790,17 +7977,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an analysis. + * Deletes an AuthorizedView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7808,31 +7997,31 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7848,13 +8037,13 @@ export namespace contactcenterinsights_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Delete; options = {}; } @@ -7890,7 +8079,7 @@ export namespace contactcenterinsights_v1 { } /** - * Gets an analysis. + * Get AuthorizedView * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7898,57 +8087,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$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$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Get; options = {}; } @@ -7974,19 +8163,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists analyses. + * List AuthorizedViewSets * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7994,57 +8183,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$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$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$List; options = {}; } @@ -8058,7 +8247,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( + url: (rootUrl + '/v1/{+parent}/authorizedViews').replace( /([^:]\/)\/+/g, '$1' ), @@ -8073,130 +8262,77 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create - extends StandardParameters { - /** - * Required. The parent resource of the analysis. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete - extends StandardParameters { - /** - * Required. The name of the analysis to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get - extends StandardParameters { - /** - * Required. The name of the analysis to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List - extends StandardParameters { - /** - * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - */ - filter?: string; - /** - * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - */ - pageSize?: number; - /** - * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the analyses. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Create feedback label. + * Updates an AuthorizedView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + patch( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$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$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Patch; options = {}; } @@ -8210,88 +8346,89 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Delete feedback label. + * Query metrics. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + queryMetrics( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + queryMetrics( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + ): GaxiosPromise; + queryMetrics( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + queryMetrics( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, - callback: BodyResponseCallback + queryMetrics( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + queryMetrics( + callback: BodyResponseCallback + ): void; + queryMetrics( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics; options = {}; } @@ -8305,87 +8442,90 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+location}:queryMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Get feedback label. + * SearchAuthorizedViewSets * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + search( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Search, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + search( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Search, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + search( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Search, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - get( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Search; options = {}; } @@ -8399,89 +8539,214 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/authorizedViews:search').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Create + extends StandardParameters { /** - * List feedback labels. + * Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. See go/aip/122#resource-id-segments + */ + authorizedViewId?: string; + /** + * Required. The parent resource of the AuthorizedView. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1AuthorizedView; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Delete + extends StandardParameters { + /** + * Required. The name of the AuthorizedView to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Get + extends StandardParameters { + /** + * Required. The name of the AuthorizedView to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$List + extends StandardParameters { + /** + * Optional. The filter expression to filter authorized views listed in the response. + */ + filter?: string; + /** + * Optional. The order by expression to order authorized views listed in the response. + */ + orderBy?: string; + /** + * Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the AuthorizedView. Format: projects/{project\}/locations/{location\}/authorizedViewSets/{authorized_view_set\}/authorizedViews/{authorized_view\} + */ + name?: string; + /** + * Optional. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `conversation_filter` * `display_name` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1AuthorizedView; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Querymetrics + extends StandardParameters { + /** + * Required. The location of the data. "projects/{project\}/locations/{location\}" + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1QueryMetricsRequest; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Search + extends StandardParameters { + /** + * Optional. The order by expression to order authorized views listed in the response. + */ + orderBy?: string; + /** + * Optional. The maximum number of view to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned. + */ + parent?: string; + /** + * Optional. The query expression to search authorized views. + */ + query?: string; + } + + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations { + context: APIRequestContext; + analyses: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses; + feedbackLabels: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels; + constructor(context: APIRequestContext) { + this.context = context; + this.analyses = + new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses( + this.context + ); + this.feedbackLabels = + new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels( + this.context + ); + } + + /** + * Analyzes multiple conversations in a single request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + bulkAnalyze( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + bulkAnalyze( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + ): GaxiosPromise; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + bulkAnalyze( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, - callback: BodyResponseCallback + bulkAnalyze( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + bulkAnalyze( + callback: BodyResponseCallback ): void; - list( + bulkAnalyze( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze; options = {}; } @@ -8495,11 +8760,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -8510,77 +8775,75 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Update feedback label. + * Gets conversation statistics. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + calculateStats( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + calculateStats( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + ): GaxiosPromise; + calculateStats( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + calculateStats( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, - callback: BodyResponseCallback + calculateStats( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + calculateStats( + callback: BodyResponseCallback ): void; - patch( + calculateStats( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats; options = {}; } @@ -8594,136 +8857,65 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1/{+location}/conversations:calculateStats' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create - extends StandardParameters { - /** - * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. - */ - feedbackLabelId?: string; - /** - * Required. The parent resource of the feedback label. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete - extends StandardParameters { - /** - * Required. The name of the feedback label to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get - extends StandardParameters { - /** - * Required. The name of the feedback label to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List - extends StandardParameters { - /** - * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING - */ - filter?: string; - /** - * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - */ - pageSize?: number; - /** - * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the feedback labels. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch - extends StandardParameters { - /** - * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} - */ - name?: string; - /** - * Required. The list of fields to be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; - } - - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + delete( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, options?: MethodOptions ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete, callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8739,13 +8931,13 @@ export namespace contactcenterinsights_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete; options = {}; } @@ -8759,8 +8951,8 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -8781,7 +8973,7 @@ export namespace contactcenterinsights_v1 { } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8789,57 +8981,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$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$Authorizedviewsets$Authorizedviews$Operations$Get; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get; options = {}; } @@ -8865,17 +9057,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists conversations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8883,57 +9077,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$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$Authorizedviewsets$Authorizedviews$Operations$List; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List; options = {}; } @@ -8947,7 +9141,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -8957,110 +9151,140 @@ export namespace contactcenterinsights_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The parent resource to create analyses in. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. + */ + filter?: string; + /** + * Required. The location of the conversations. + */ + location?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Delete + extends StandardParameters { + /** + * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + */ + force?: boolean; + /** + * Required. The name of the conversation to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the conversation to get. */ name?: string; + /** + * The level of details of the conversation. Default is `FULL`. + */ + view?: string; } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$List extends StandardParameters { /** - * The standard list filter. + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. */ filter?: string; /** - * The name of the operation's parent resource. + * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. */ pageSize?: number; /** - * The standard list page token. + * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. */ pageToken?: string; + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + /** + * The level of details of the conversation. Default is `BASIC`. + */ + view?: string; } - export class Resource$Projects$Locations$Conversations { + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses { context: APIRequestContext; - analyses: Resource$Projects$Locations$Conversations$Analyses; - feedbackLabels: Resource$Projects$Locations$Conversations$Feedbacklabels; constructor(context: APIRequestContext) { this.context = context; - this.analyses = new Resource$Projects$Locations$Conversations$Analyses( - this.context - ); - this.feedbackLabels = - new Resource$Projects$Locations$Conversations$Feedbacklabels( - this.context - ); } /** - * Analyzes multiple conversations in a single request. + * Creates an analysis. The long running operation is done when the analysis has completed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, options: StreamMethodOptions ): GaxiosPromise; - bulkAnalyze( - params?: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + create( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, options?: MethodOptions ): GaxiosPromise; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, callback: BodyResponseCallback ): void; - bulkAnalyze( + create( callback: BodyResponseCallback ): void; - bulkAnalyze( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Bulkanalyze + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9076,13 +9300,13 @@ export namespace contactcenterinsights_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create; options = {}; } @@ -9096,7 +9320,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( + url: (rootUrl + '/v1/{+parent}/analyses').replace( /([^:]\/)\/+/g, '$1' ), @@ -9121,65 +9345,61 @@ export namespace contactcenterinsights_v1 { } /** - * Deletes multiple conversations in a single request. + * Deletes an analysis. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, options: StreamMethodOptions ): GaxiosPromise; - bulkDelete( - params?: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + delete( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, options?: MethodOptions - ): GaxiosPromise; - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkDelete( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + callback: BodyResponseCallback ): void; - bulkDelete( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Bulkdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$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$Conversations$Bulkdelete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Bulkdelete; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete; options = {}; } @@ -9193,90 +9413,87 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:bulkDelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets conversation statistics. + * Gets an analysis. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, options: StreamMethodOptions ): GaxiosPromise; - calculateStats( - params?: Params$Resource$Projects$Locations$Conversations$Calculatestats, + get( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, options?: MethodOptions - ): GaxiosPromise; - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, + callback: BodyResponseCallback ): void; - calculateStats( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - calculateStats( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Calculatestats - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$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$Conversations$Calculatestats; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Calculatestats; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get; options = {}; } @@ -9290,33 +9507,183 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+location}/conversations:calculateStats' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead. + * Lists analyses. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/analyses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create + extends StandardParameters { + /** + * Required. The parent resource of the analysis. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete + extends StandardParameters { + /** + * Required. The name of the analysis to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get + extends StandardParameters { + /** + * Required. The name of the analysis to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + */ + filter?: string; + /** + * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the analyses. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9324,56 +9691,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Conversations$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Conversations$Create, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Conversations$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$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$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Create; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; options = {}; } @@ -9387,7 +9755,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), @@ -9402,19 +9770,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a conversation. + * Delete feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9422,31 +9790,31 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Conversations$Delete, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Delete + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9462,12 +9830,13 @@ export namespace contactcenterinsights_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Delete; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; options = {}; } @@ -9503,7 +9872,7 @@ export namespace contactcenterinsights_v1 { } /** - * Gets a conversation. + * Get feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9511,56 +9880,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Conversations$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Conversations$Get, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Conversations$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Conversations$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Conversations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$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$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Get; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; options = {}; } @@ -9586,115 +9956,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Imports conversations and processes them according to the user's configuration. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, - options: StreamMethodOptions - ): GaxiosPromise; - ingest( - params?: Params$Resource$Projects$Locations$Conversations$Ingest, - options?: MethodOptions - ): GaxiosPromise; - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, - callback: BodyResponseCallback - ): void; - ingest( - callback: BodyResponseCallback - ): void; - ingest( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Ingest - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Ingest; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Ingest; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/conversations:ingest').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists conversations. + * List feedback labels. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9702,56 +9976,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Conversations$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Conversations$List, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Conversations$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Conversations$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Conversations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$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$Conversations$List; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$List; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; options = {}; } @@ -9765,7 +10040,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), @@ -9780,19 +10055,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a conversation. + * Update feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9800,56 +10075,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Conversations$Patch, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$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$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Patch; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; options = {}; } @@ -9875,76 +10151,2876 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create + extends StandardParameters { /** - * Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. */ - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, - options: StreamMethodOptions - ): GaxiosPromise; - upload( - params?: Params$Resource$Projects$Locations$Conversations$Upload, - options?: MethodOptions - ): GaxiosPromise; - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, - callback: BodyResponseCallback - ): void; - upload( - callback: BodyResponseCallback - ): void; - upload( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Upload - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): + feedbackLabelId?: string; + /** + * Required. The parent resource of the feedback label. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete + extends StandardParameters { + /** + * Required. The name of the feedback label to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get + extends StandardParameters { + /** + * Required. The name of the feedback label to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List + extends StandardParameters { + /** + * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + */ + filter?: string; + /** + * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the feedback labels. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch + extends StandardParameters { + /** + * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} + */ + name?: string; + /** + * Required. The list of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + } + + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Authorizedviewsets$Authorizedviews$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists 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$Authorizedviewsets$Authorizedviews$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Conversations { + context: APIRequestContext; + analyses: Resource$Projects$Locations$Conversations$Analyses; + feedbackLabels: Resource$Projects$Locations$Conversations$Feedbacklabels; + constructor(context: APIRequestContext) { + this.context = context; + this.analyses = new Resource$Projects$Locations$Conversations$Analyses( + this.context + ); + this.feedbackLabels = + new Resource$Projects$Locations$Conversations$Feedbacklabels( + this.context + ); + } + + /** + * Analyzes multiple conversations in a single request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + options: StreamMethodOptions + ): GaxiosPromise; + bulkAnalyze( + params?: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + options?: MethodOptions + ): GaxiosPromise; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + callback: BodyResponseCallback + ): void; + bulkAnalyze( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Bulkanalyze + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes multiple conversations in a single request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + options: StreamMethodOptions + ): GaxiosPromise; + bulkDelete( + params?: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + options?: MethodOptions + ): GaxiosPromise; + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + callback: BodyResponseCallback + ): void; + bulkDelete( + callback: BodyResponseCallback + ): void; + bulkDelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Bulkdelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Bulkdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Bulkdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations:bulkDelete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets conversation statistics. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + options: StreamMethodOptions + ): GaxiosPromise; + calculateStats( + params?: Params$Resource$Projects$Locations$Conversations$Calculatestats, + options?: MethodOptions + ): GaxiosPromise; + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + callback: BodyResponseCallback + ): void; + calculateStats( + callback: BodyResponseCallback + ): void; + calculateStats( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Calculatestats + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Calculatestats; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Calculatestats; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+location}/conversations:calculateStats' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Conversations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Conversations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Conversations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a conversation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Conversations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a conversation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Conversations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Conversations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Conversations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Imports conversations and processes them according to the user's configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, + options: StreamMethodOptions + ): GaxiosPromise; + ingest( + params?: Params$Resource$Projects$Locations$Conversations$Ingest, + options?: MethodOptions + ): GaxiosPromise; + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, + callback: BodyResponseCallback + ): void; + ingest( + callback: BodyResponseCallback + ): void; + ingest( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Ingest + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Ingest; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Ingest; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations:ingest').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists conversations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Conversations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Conversations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Conversations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a conversation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Conversations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Projects$Locations$Conversations$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Conversations$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations:upload').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Conversations$Bulkanalyze + extends StandardParameters { + /** + * Required. The parent resource to create analyses in. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$Bulkdelete + extends StandardParameters { + /** + * Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$Calculatestats + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. + */ + filter?: string; + /** + * Required. The location of the conversations. + */ + location?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Create + extends StandardParameters { + /** + * A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64\}$`. Valid characters are `a-z-` + */ + conversationId?: string; + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; + } + export interface Params$Resource$Projects$Locations$Conversations$Delete + extends StandardParameters { + /** + * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + */ + force?: boolean; + /** + * Required. The name of the conversation to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Get + extends StandardParameters { + /** + * Required. The name of the conversation to get. + */ + name?: string; + /** + * The level of details of the conversation. Default is `FULL`. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Ingest + extends StandardParameters { + /** + * Required. The parent resource for new conversations. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$List + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + */ + filter?: string; + /** + * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + */ + orderBy?: string; + /** + * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + */ + pageSize?: number; + /** + * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + /** + * The level of details of the conversation. Default is `BASIC`. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Patch + extends StandardParameters { + /** + * Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} + */ + name?: string; + /** + * The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; + } + export interface Params$Resource$Projects$Locations$Conversations$Upload + extends StandardParameters { + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1UploadConversationRequest; + } + + export class Resource$Projects$Locations$Conversations$Analyses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an analysis. The long running operation is done when the analysis has completed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Analyses$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Analyses$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/analyses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an analysis. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Analyses$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an analysis. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Analyses$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Analyses$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists analyses. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Analyses$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Analyses$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/analyses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Conversations$Analyses$Create + extends StandardParameters { + /** + * Required. The parent resource of the analysis. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; + } + export interface Params$Resource$Projects$Locations$Conversations$Analyses$Delete + extends StandardParameters { + /** + * Required. The name of the analysis to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Analyses$Get + extends StandardParameters { + /** + * Required. The name of the analysis to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Analyses$List + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + */ + filter?: string; + /** + * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the analyses. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Conversations$Feedbacklabels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create feedback label. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Delete feedback label. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get feedback label. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List feedback labels. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update feedback label. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create + extends StandardParameters { + /** + * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. + */ + feedbackLabelId?: string; + /** + * Required. The parent resource of the feedback label. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete + extends StandardParameters { + /** + * Required. The name of the feedback label to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get + extends StandardParameters { + /** + * Required. The name of the feedback label to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List + extends StandardParameters { + /** + * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + */ + filter?: string; + /** + * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the feedback labels. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch + extends StandardParameters { + /** + * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} + */ + name?: string; + /** + * Required. The list of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + } + + export class Resource$Projects$Locations$Datasets { + context: APIRequestContext; + conversations: Resource$Projects$Locations$Datasets$Conversations; + insightsdata: Resource$Projects$Locations$Datasets$Insightsdata; + constructor(context: APIRequestContext) { + this.context = context; + this.conversations = + new Resource$Projects$Locations$Datasets$Conversations(this.context); + this.insightsdata = new Resource$Projects$Locations$Datasets$Insightsdata( + this.context + ); + } + + /** + * Delete feedback labels in bulk using a filter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, + options: StreamMethodOptions + ): GaxiosPromise; + bulkDeleteFeedbackLabels( + params?: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, + options?: MethodOptions + ): GaxiosPromise; + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, + callback: BodyResponseCallback + ): void; + bulkDeleteFeedbackLabels( + callback: BodyResponseCallback + ): void; + bulkDeleteFeedbackLabels( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:bulkDeleteFeedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkDownloadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + options: StreamMethodOptions + ): GaxiosPromise; + bulkDownloadFeedbackLabels( + params?: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + options?: MethodOptions + ): GaxiosPromise; + bulkDownloadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDownloadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkDownloadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + callback: BodyResponseCallback + ): void; + bulkDownloadFeedbackLabels( + callback: BodyResponseCallback + ): void; + bulkDownloadFeedbackLabels( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:bulkDownloadFeedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkUploadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + options: StreamMethodOptions + ): GaxiosPromise; + bulkUploadFeedbackLabels( + params?: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + options?: MethodOptions + ): GaxiosPromise; + bulkUploadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkUploadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkUploadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + callback: BodyResponseCallback + ): void; + bulkUploadFeedbackLabels( + callback: BodyResponseCallback + ): void; + bulkUploadFeedbackLabels( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:bulkUploadFeedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List all feedback labels by project number. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + options: StreamMethodOptions + ): GaxiosPromise; + listAllFeedbackLabels( + params?: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + options?: MethodOptions + ): GaxiosPromise; + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + callback: BodyResponseCallback + ): void; + listAllFeedbackLabels( + callback: BodyResponseCallback + ): void; + listAllFeedbackLabels( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Upload; + {}) as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Upload; + params = + {} as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; options = {}; } @@ -9958,11 +13034,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:upload').replace( + url: (rootUrl + '/v1/{+parent}:listAllFeedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -9973,201 +13049,225 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Conversations$Bulkanalyze - extends StandardParameters { - /** - * Required. The parent resource to create analyses in. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Conversations$Bulkdelete + export interface Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels extends StandardParameters { /** - * Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} + * Required. The parent resource for new feedback labels. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Conversations$Calculatestats - extends StandardParameters { - /** - * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. - */ - filter?: string; - /** - * Required. The location of the conversations. - */ - location?: string; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest; } - export interface Params$Resource$Projects$Locations$Conversations$Create + export interface Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels extends StandardParameters { /** - * A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64\}$`. Valid characters are `a-z-` - */ - conversationId?: string; - /** - * Required. The parent resource of the conversation. + * Required. The parent resource for new feedback labels. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; - } - export interface Params$Resource$Projects$Locations$Conversations$Delete - extends StandardParameters { - /** - * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. - */ - force?: boolean; - /** - * Required. The name of the conversation to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Get - extends StandardParameters { - /** - * Required. The name of the conversation to get. - */ - name?: string; - /** - * The level of details of the conversation. Default is `FULL`. - */ - view?: string; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest; } - export interface Params$Resource$Projects$Locations$Conversations$Ingest + export interface Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels extends StandardParameters { /** - * Required. The parent resource for new conversations. + * Required. The parent resource for new feedback labels. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest; } - export interface Params$Resource$Projects$Locations$Conversations$List + export interface Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels extends StandardParameters { /** - * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + * Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING */ filter?: string; /** - * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). - */ - orderBy?: string; - /** - * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. */ pageSize?: number; /** - * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. + * Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the conversation. + * Required. The parent resource of all feedback labels per project. */ parent?: string; - /** - * The level of details of the conversation. Default is `BASIC`. - */ - view?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Patch - extends StandardParameters { - /** - * Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} - */ - name?: string; - /** - * The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri` - */ - updateMask?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; - } - export interface Params$Resource$Projects$Locations$Conversations$Upload - extends StandardParameters { - /** - * Required. The parent resource of the conversation. - */ - parent?: string; + export class Resource$Projects$Locations$Datasets$Conversations { + context: APIRequestContext; + analyses: Resource$Projects$Locations$Datasets$Conversations$Analyses; + feedbackLabels: Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels; + constructor(context: APIRequestContext) { + this.context = context; + this.analyses = + new Resource$Projects$Locations$Datasets$Conversations$Analyses( + this.context + ); + this.feedbackLabels = + new Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels( + this.context + ); + } /** - * Request body metadata + * Analyzes multiple conversations in a single request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$GoogleCloudContactcenterinsightsV1UploadConversationRequest; - } + bulkAnalyze( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + options: StreamMethodOptions + ): GaxiosPromise; + bulkAnalyze( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + options?: MethodOptions + ): GaxiosPromise; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + callback: BodyResponseCallback + ): void; + bulkAnalyze( + callback: BodyResponseCallback + ): void; + bulkAnalyze( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Conversations$Analyses { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates an analysis. The long running operation is done when the analysis has completed. + * Deletes multiple conversations in a single request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + bulkDelete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + bulkDelete( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + bulkDelete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + bulkDelete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + bulkDelete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, callback: BodyResponseCallback ): void; - create( + bulkDelete( callback: BodyResponseCallback ): void; - create( + bulkDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$Create + | Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10183,13 +13283,13 @@ export namespace contactcenterinsights_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$Create; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete; options = {}; } @@ -10203,7 +13303,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( + url: (rootUrl + '/v1/{+parent}/conversations:bulkDelete').replace( /([^:]\/)\/+/g, '$1' ), @@ -10228,7 +13328,105 @@ export namespace contactcenterinsights_v1 { } /** - * Deletes an analysis. + * Gets conversation statistics. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + calculateStats( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + options: StreamMethodOptions + ): GaxiosPromise; + calculateStats( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + options?: MethodOptions + ): GaxiosPromise; + calculateStats( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calculateStats( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + calculateStats( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + callback: BodyResponseCallback + ): void; + calculateStats( + callback: BodyResponseCallback + ): void; + calculateStats( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+location}/conversations:calculateStats' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10236,31 +13434,31 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$Delete + | Params$Resource$Projects$Locations$Datasets$Conversations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10276,13 +13474,13 @@ export namespace contactcenterinsights_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; options = {}; } @@ -10318,7 +13516,7 @@ export namespace contactcenterinsights_v1 { } /** - * Gets an analysis. + * Gets a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10326,57 +13524,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$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$Conversations$Analyses$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$Get; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Get; options = {}; } @@ -10397,24 +13595,121 @@ export namespace contactcenterinsights_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Imports conversations and processes them according to the user's configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + options: StreamMethodOptions + ): GaxiosPromise; + ingest( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + options?: MethodOptions + ): GaxiosPromise; + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + callback: BodyResponseCallback + ): void; + ingest( + callback: BodyResponseCallback + ): void; + ingest( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Conversations$Ingest + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Ingest; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Ingest; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/conversations:ingest').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists analyses. + * Lists conversations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10422,57 +13717,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$List, + params?: Params$Resource$Projects$Locations$Datasets$Conversations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$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$Conversations$Analyses$List; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$List; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$List; options = {}; } @@ -10486,7 +13781,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( + url: (rootUrl + '/v1/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -10501,72 +13796,124 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$Create + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze extends StandardParameters { /** - * Required. The parent resource of the analysis. + * Required. The parent resource to create analyses in. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$Delete + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete extends StandardParameters { /** - * Required. The name of the analysis to delete. + * Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats + extends StandardParameters { + /** + * Required. The location of the conversations. + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1CalculateStatsRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Delete + extends StandardParameters { + /** + * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + */ + force?: boolean; + /** + * Required. The name of the conversation to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$Get + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Get extends StandardParameters { /** - * Required. The name of the analysis to get. + * Required. The name of the conversation to get. */ name?: string; + /** + * The level of details of the conversation. Default is `FULL`. + */ + view?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$List + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Ingest + extends StandardParameters { + /** + * Required. The parent resource for new conversations. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$List extends StandardParameters { /** * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. */ filter?: string; /** - * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + */ + orderBy?: string; + /** + * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. */ pageSize?: number; /** - * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. + * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the analyses. + * Required. The parent resource of the conversation. */ parent?: string; + /** + * The level of details of the conversation. Default is `BASIC`. + */ + view?: string; } - export class Resource$Projects$Locations$Conversations$Feedbacklabels { + export class Resource$Projects$Locations$Datasets$Conversations$Analyses { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Create feedback label. + * Creates an analysis. The long running operation is done when the analysis has completed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10574,57 +13921,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$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$Conversations$Feedbacklabels$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create; options = {}; } @@ -10638,7 +13985,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + url: (rootUrl + '/v1/{+parent}/analyses').replace( /([^:]\/)\/+/g, '$1' ), @@ -10653,167 +14000,71 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Delete feedback label. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Get feedback label. + * Deletes an analysis. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$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$Conversations$Feedbacklabels$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete; options = {}; } @@ -10828,7 +14079,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -10839,77 +14090,75 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List feedback labels. + * Gets an analysis. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + get( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$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$Conversations$Feedbacklabels$List; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get; options = {}; } @@ -10923,92 +14172,89 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Update feedback label. + * Lists analyses. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + list( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$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$Conversations$Feedbacklabels$Patch; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List; options = {}; } @@ -11022,118 +14268,186 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/analyses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create extends StandardParameters { /** - * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. - */ - feedbackLabelId?: string; - /** - * Required. The parent resource of the feedback label. + * Required. The parent resource of the analysis. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete extends StandardParameters { /** - * Required. The name of the feedback label to delete. + * Required. The name of the analysis to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get extends StandardParameters { /** - * Required. The name of the feedback label to get. + * Required. The name of the analysis to get. */ name?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List extends StandardParameters { /** - * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. */ filter?: string; /** - * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. */ pageSize?: number; /** - * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. + * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the feedback labels. + * Required. The parent resource of the analyses. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch - extends StandardParameters { - /** - * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} - */ - name?: string; - /** - * Required. The list of fields to be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; - } - export class Resource$Projects$Locations$Datasets { + export class Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels { context: APIRequestContext; - conversations: Resource$Projects$Locations$Datasets$Conversations; - insightsdata: Resource$Projects$Locations$Datasets$Insightsdata; constructor(context: APIRequestContext) { this.context = context; - this.conversations = - new Resource$Projects$Locations$Datasets$Conversations(this.context); - this.insightsdata = new Resource$Projects$Locations$Datasets$Insightsdata( - this.context - ); } - } - export class Resource$Projects$Locations$Datasets$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + /** + * Create feedback label. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Datasets$Conversations$Feedbacklabels$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Deletes a conversation. + * Delete feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11141,31 +14455,31 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Delete + | Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11181,13 +14495,13 @@ export namespace contactcenterinsights_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Delete; options = {}; } @@ -11223,7 +14537,7 @@ export namespace contactcenterinsights_v1 { } /** - * Gets a conversation. + * Get feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11231,57 +14545,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$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$Datasets$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Get; options = {}; } @@ -11307,77 +14621,77 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Imports conversations and processes them according to the user's configuration. + * List feedback labels. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - ingest( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$List, options: StreamMethodOptions ): GaxiosPromise; - ingest( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + list( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$List, options?: MethodOptions - ): GaxiosPromise; - ingest( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - ingest( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - ingest( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$List, + callback: BodyResponseCallback ): void; - ingest( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - ingest( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Ingest - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$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$Datasets$Conversations$Ingest; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Ingest; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$List; options = {}; } @@ -11391,11 +14705,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:ingest').replace( + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -11406,75 +14720,77 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists conversations. + * Update feedback label. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$List, + patch( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$List, + patch( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$List, + patch( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$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$Datasets$Conversations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$List; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Patch; options = {}; } @@ -11488,93 +14804,94 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Delete + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Create extends StandardParameters { /** - * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. */ - force?: boolean; + feedbackLabelId?: string; /** - * Required. The name of the conversation to delete. + * Required. The parent resource of the feedback label. */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Get + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Delete extends StandardParameters { /** - * Required. The name of the conversation to get. + * Required. The name of the feedback label to delete. */ name?: string; - /** - * The level of details of the conversation. Default is `FULL`. - */ - view?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Ingest + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Get extends StandardParameters { /** - * Required. The parent resource for new conversations. - */ - parent?: string; - - /** - * Request body metadata + * Required. The name of the feedback label to get. */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$List + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$List extends StandardParameters { /** - * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING */ filter?: string; /** - * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). - */ - orderBy?: string; - /** - * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. */ pageSize?: number; /** - * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. + * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the conversation. + * Required. The parent resource of the feedback labels. */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels$Patch + extends StandardParameters { /** - * The level of details of the conversation. Default is `BASIC`. + * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} */ - view?: string; + name?: string; + /** + * Required. The list of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; } export class Resource$Projects$Locations$Datasets$Insightsdata { diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 5f465ec20b..3bfe75bd86 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -585,6 +585,10 @@ export namespace container_v1 { * Configurations for the various addons available to run in the cluster. */ addonsConfig?: Schema$AddonsConfig; + /** + * The list of user specified Kubernetes feature gates. Each string represents the activation status of a feature gate (e.g. "featureX=true" or "featureX=false") + */ + alphaClusterFeatureGates?: string[] | null; /** * Configuration controlling RBAC group membership information. */ @@ -2153,6 +2157,15 @@ export namespace container_v1 { */ maxPodsPerNode?: string | null; } + /** + * The option enables the Kubernetes NUMA-aware Memory Manager feature. Detailed description about the feature can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/). + */ + export interface Schema$MemoryManager { + /** + * Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. + */ + policy?: string | null; + } /** * Configuration for issuance of mTLS keys and certificates to Kubernetes pods. */ @@ -2589,10 +2602,18 @@ export namespace container_v1 { * Enable or disable Kubelet read only port. */ insecureKubeletReadonlyPortEnabled?: boolean | null; + /** + * Optional. Controls NUMA-aware Memory Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/ + */ + memoryManager?: Schema$MemoryManager; /** * Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. */ podPidsLimit?: string | null; + /** + * Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + */ + topologyManager?: Schema$TopologyManager; } /** * Collection of node-level [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels). @@ -3929,6 +3950,19 @@ export namespace container_v1 { */ startTime?: string | null; } + /** + * TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + */ + export interface Schema$TopologyManager { + /** + * Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). + */ + policy?: string | null; + /** + * The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes + */ + scope?: string | null; + } /** * UpdateClusterRequest updates the settings of a cluster. */ diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 4cd903cf02..5836375e2b 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -635,6 +635,10 @@ export namespace container_v1beta1 { * Configurations for the various addons available to run in the cluster. */ addonsConfig?: Schema$AddonsConfig; + /** + * The list of user specified Kubernetes feature gates. Each string represents the activation status of a feature gate (e.g. "featureX=true" or "featureX=false") + */ + alphaClusterFeatureGates?: string[] | null; /** * Configuration controlling RBAC group membership information. */ @@ -2383,6 +2387,15 @@ export namespace container_v1beta1 { */ maxPodsPerNode?: string | null; } + /** + * The option enables the Kubernetes NUMA-aware Memory Manager feature. Detailed description about the feature can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/). + */ + export interface Schema$MemoryManager { + /** + * Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. + */ + policy?: string | null; + } /** * Configuration for issuance of mTLS keys and certificates to Kubernetes pods. */ @@ -2835,10 +2848,18 @@ export namespace container_v1beta1 { * Enable or disable Kubelet read only port. */ insecureKubeletReadonlyPortEnabled?: boolean | null; + /** + * Optional. Controls NUMA-aware Memory Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/ + */ + memoryManager?: Schema$MemoryManager; /** * Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. */ podPidsLimit?: string | null; + /** + * Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + */ + topologyManager?: Schema$TopologyManager; } /** * Collection of node-level [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels). @@ -4252,6 +4273,19 @@ export namespace container_v1beta1 { */ startTime?: string | null; } + /** + * TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + */ + export interface Schema$TopologyManager { + /** + * Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). + */ + policy?: string | null; + /** + * The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes + */ + scope?: string | null; + } /** * Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. */ diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index 75e505aa60..b7e2bdc229 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -2252,6 +2252,10 @@ export namespace containeranalysis_v1 { * The base images the layer is found within. */ baseImages?: Schema$BaseImage[]; + /** + * The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid + */ + chainId?: string | null; /** * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. */ @@ -2448,6 +2452,10 @@ export namespace containeranalysis_v1 { * A note describing an SBOM reference. */ sbomReference?: Schema$SBOMReferenceNote; + /** + * A note describing a secret. + */ + secret?: Schema$SecretNote; /** * A one sentence description of this note. */ @@ -2537,6 +2545,10 @@ export namespace containeranalysis_v1 { * Describes a specific SBOM reference occurrences. */ sbomReference?: Schema$SBOMReferenceOccurrence; + /** + * Describes a secret. + */ + secret?: Schema$SecretOccurrence; /** * Output only. The time this occurrence was last updated. */ @@ -2913,6 +2925,53 @@ export namespace containeranalysis_v1 { */ sbomState?: string | null; } + /** + * The location of the secret. + */ + export interface Schema$SecretLocation { + /** + * The secret is found from a file. + */ + fileLocation?: Schema$GrafeasV1FileLocation; + } + /** + * The note representing a secret. + */ + export interface Schema$SecretNote {} + /** + * The occurrence provides details of a secret. + */ + export interface Schema$SecretOccurrence { + /** + * Required. Type of secret. + */ + kind?: string | null; + /** + * Optional. Locations where the secret is detected. + */ + locations?: Schema$SecretLocation[]; + /** + * Optional. Status of the secret. + */ + statuses?: Schema$SecretStatus[]; + } + /** + * The status of the secret with a timestamp. + */ + export interface Schema$SecretStatus { + /** + * Optional. Optional message about the status code. + */ + message?: string | null; + /** + * Optional. The status of the secret. + */ + status?: string | null; + /** + * Optional. The time the secret status was last updated. + */ + updateTime?: string | null; + } /** * Request message for `SetIamPolicy` method. */ diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 0515919b43..97a736f526 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -2719,6 +2719,10 @@ export namespace containeranalysis_v1alpha1 { * A note describing a reference to an SBOM. */ sbomReference?: Schema$SBOMReferenceNote; + /** + * A note describing a secret. + */ + secret?: Schema$SecretNote; /** * A one sentence description of this `Note`. */ @@ -2828,6 +2832,10 @@ export namespace containeranalysis_v1alpha1 { * This represents an SBOM reference occurrence */ sbomReference?: Schema$SBOMReferenceOccurrence; + /** + * This represents a secret occurrence + */ + secret?: Schema$SecretOccurrence; /** * Describes a specific SPDX File. */ @@ -3391,6 +3399,53 @@ export namespace containeranalysis_v1alpha1 { */ updateTime?: string | null; } + /** + * The location of the secret. + */ + export interface Schema$SecretLocation { + /** + * The secret is found from a file. + */ + fileLocation?: Schema$FileLocation; + } + /** + * The note representing a secret. + */ + export interface Schema$SecretNote {} + /** + * The occurrence provides details of a secret. + */ + export interface Schema$SecretOccurrence { + /** + * Required. Type of secret. + */ + kind?: string | null; + /** + * Optional. Locations where the secret is detected. + */ + locations?: Schema$SecretLocation[]; + /** + * Optional. Status of the secret. + */ + statuses?: Schema$SecretStatus[]; + } + /** + * The status of the secret with a timestamp. + */ + export interface Schema$SecretStatus { + /** + * Optional. Optional message about the status code. + */ + message?: string | null; + /** + * Optional. The status of the secret. + */ + status?: string | null; + /** + * Optional. The time the secret status was last updated. + */ + updateTime?: string | null; + } /** * Request message for `SetIamPolicy` method. */ diff --git a/src/apis/datacatalog/v1.ts b/src/apis/datacatalog/v1.ts index fcca123cd7..6b843bebed 100644 --- a/src/apis/datacatalog/v1.ts +++ b/src/apis/datacatalog/v1.ts @@ -793,7 +793,7 @@ export namespace datacatalog_v1 { */ export interface Schema$GoogleCloudDatacatalogV1GcsFilesetSpec { /** - * Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/x`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/x*`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/x/b`: matches all files in `bucket_name` that match the `a/x/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` + * Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/wildcards). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/x`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/x*`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/x/b`: matches all files in `bucket_name` that match the `a/x/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` */ filePatterns?: string[] | null; /** diff --git a/src/apis/datacatalog/v1beta1.ts b/src/apis/datacatalog/v1beta1.ts index 0730e49b35..7d6600ce76 100644 --- a/src/apis/datacatalog/v1beta1.ts +++ b/src/apis/datacatalog/v1beta1.ts @@ -362,7 +362,7 @@ export namespace datacatalog_v1beta1 { */ export interface Schema$GoogleCloudDatacatalogV1beta1GcsFilesetSpec { /** - * Required. Patterns to identify a set of files in Google Cloud Storage. See [Cloud Storage documentation](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames) for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * `gs://bucket_name/dir/x`: matches all files within `bucket_name/dir` directory. * `gs://bucket_name/dir/x*`: matches all files in `bucket_name/dir` spanning all subdirectories. * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/x/b`: matches all files in `bucket_name` that match `a/x/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to provide more powerful matches, for example: * `gs://bucket_name/[a-m]??.j*g` + * Required. Patterns to identify a set of files in Google Cloud Storage. See [Cloud Storage documentation](https://cloud.google.com/storage/docs/wildcards) for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * `gs://bucket_name/dir/x`: matches all files within `bucket_name/dir` directory. * `gs://bucket_name/dir/x*`: matches all files in `bucket_name/dir` spanning all subdirectories. * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/x/b`: matches all files in `bucket_name` that match `a/x/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to provide more powerful matches, for example: * `gs://bucket_name/[a-m]??.j*g` */ filePatterns?: string[] | null; /** @@ -1441,7 +1441,7 @@ export namespace datacatalog_v1beta1 { */ export interface Schema$GoogleCloudDatacatalogV1GcsFilesetSpec { /** - * Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/x`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/x*`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/x/b`: matches all files in `bucket_name` that match the `a/x/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` + * Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/wildcards). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/x`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/x*`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/x/b`: matches all files in `bucket_name` that match the `a/x/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` */ filePatterns?: string[] | null; /** diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index f6c3a2aee3..41471261b3 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -923,6 +923,10 @@ export namespace dataflow_v1b3 { * The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME\} to this resource prefix, where {JOBNAME\} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket\}/{object\} bucket.storage.googleapis.com/{object\} */ tempStoragePrefix?: string | null; + /** + * Optional. True when any worker pool that uses public IPs is present. + */ + usePublicIps?: boolean | null; /** * A description of the process that generated the request. */ diff --git a/src/apis/datamigration/v1.ts b/src/apis/datamigration/v1.ts index 2d4000f558..351669cf15 100644 --- a/src/apis/datamigration/v1.ts +++ b/src/apis/datamigration/v1.ts @@ -684,6 +684,10 @@ export namespace datamigration_v1 { * Required. The destination engine details. */ destination?: Schema$DatabaseEngineInfo; + /** + * Optional. The provider for the destination database. + */ + destinationProvider?: string | null; /** * Optional. The display name for the workspace. */ @@ -712,6 +716,10 @@ export namespace datamigration_v1 { * Required. The source engine details. */ source?: Schema$DatabaseEngineInfo; + /** + * Optional. The provider for the source database. + */ + sourceProvider?: string | null; /** * Output only. The timestamp when the workspace resource was last updated. */ diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index b3131eb8fe..82838e572f 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -2516,7 +2516,7 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * EntryLink represents a link between two entries. + * EntryLink represents a link between two Entries. */ export interface Schema$GoogleCloudDataplexV1EntryLink { /** @@ -2524,15 +2524,15 @@ export namespace dataplex_v1 { */ createTime?: string | null; /** - * Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link, of the form: projects/{project\}/locations/{location\}/entryLinkTypes/{entry_link_type\}. + * Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link, of the form: `projects/{project_id_or_number\}/locations/{location_id\}/entryLinkTypes/{entry_link_type_id\}. */ entryLinkType?: string | null; /** - * Required. Specifies the entries referenced in the entry link. There should be exactly two entry references. + * Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. */ entryReferences?: Schema$GoogleCloudDataplexV1EntryLinkEntryReference[]; /** - * Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entryLinks/{entry_link\}. + * Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}/entryLinks/{entry_link_id\} */ name?: string | null; /** @@ -2541,19 +2541,19 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * Reference to the Entry that is linked through the entry link. + * Reference to the Entry that is linked through the Entry Link. */ export interface Schema$GoogleCloudDataplexV1EntryLinkEntryReference { /** - * Required. Immutable. The relative resource name of the referenced entry, of the form: projects/{project\}/locations/{location\}/entryGroups/{entryGroup\}/entries/{entry\}. + * Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}/entries/{entry_id\} */ name?: string | null; /** - * Immutable. The path in the entry that is referenced in the entry link. Empty path denotes that the entry itself is referenced in the entry link. + * Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. */ path?: string | null; /** - * Required. Immutable. The reference type of the entry. + * Required. Immutable. The reference type of the Entry. */ type?: string | null; } @@ -6589,7 +6589,7 @@ export namespace dataplex_v1 { 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\}. + * Required. The project to which the request should be attributed in the following form: projects/{project\}/locations/global. */ name?: string; /** @@ -13247,7 +13247,7 @@ export namespace dataplex_v1 { } /** - * Gets an entry link. + * Gets an Entry Link. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13349,7 +13349,7 @@ export namespace dataplex_v1 { */ entryLinkId?: string; /** - * Required. The resource name of the parent Entry Group: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}. + * Required. The resource name of the parent Entry Group: projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. */ parent?: string; @@ -13361,14 +13361,14 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$Entrygroups$Entrylinks$Delete extends StandardParameters { /** - * Required. The resource name of the Entry Link: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entryLinks/{entry_link\}. + * Required. The resource name of the Entry Link: projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}/entryLinks/{entry_link_id\}. */ name?: string; } export interface Params$Resource$Projects$Locations$Entrygroups$Entrylinks$Get extends StandardParameters { /** - * Required. The resource name of the Entry Link: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entryLinks/{entry_link\}. + * Required. The resource name of the Entry Link: projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}/entryLinks/{entry_link_id\}. */ name?: string; } diff --git a/src/apis/datastream/v1.ts b/src/apis/datastream/v1.ts index 7d902cd032..6655876ff5 100644 --- a/src/apis/datastream/v1.ts +++ b/src/apis/datastream/v1.ts @@ -834,7 +834,7 @@ export namespace datastream_v1 { */ export interface Schema$MongodbProfile { /** - * Required. List of host addresses for a MongoDB cluster. + * Required. List of host addresses for a MongoDB cluster. For SRV connection format, this list must contain exactly one DNS host without a port. For Standard connection format, this list must contain all the required hosts in the cluster with their respective ports. */ hostAddresses?: Schema$HostAddress[]; /** @@ -842,7 +842,7 @@ export namespace datastream_v1 { */ password?: string | null; /** - * Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster. + * Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster. For SRV connection format, this field must be empty. For Standard connection format, this field must be specified. */ replicaSet?: string | null; /** @@ -874,6 +874,10 @@ export namespace datastream_v1 { * MongoDB collections to include in the stream. */ includeObjects?: Schema$MongodbCluster; + /** + * Optional. Maximum number of concurrent backfill tasks. The number should be non-negative and less than or equal to 50. If not set (or set to 0), the system's default value is used + */ + maxConcurrentBackfillTasks?: number | null; } /** * CDC strategy to start replicating from the most recent position in the source. @@ -2035,7 +2039,12 @@ export namespace datastream_v1 { /** * Standard connection format. */ - export interface Schema$StandardConnectionFormat {} + export interface Schema$StandardConnectionFormat { + /** + * Optional. Specifies whether the client connects directly to the host[:port] in the connection URI. + */ + directConnection?: boolean | null; + } /** * Request for manually initiating a backfill job for a specific stream object. */ diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index a72d2870d7..e571b55bd6 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -7333,6 +7333,10 @@ export namespace dialogflow_v2 { * The resource name of the existing created generator. Format: `projects//locations//generators/` */ generatorName?: string | null; + /** + * Optional. Name of the CX SecuritySettings which is used to redact generated response. If this field is empty, try to fetch v2 security_settings, which is a project level setting. If this field is empty and no v2 security_settings set up in this project, no redaction will be done. Format: `projects//locations//securitySettings/`. + */ + securitySettings?: string | null; /** * Optional. A list of trigger events. Generator will be triggered only if it's trigger event is included here. */ diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 2c1eda8884..1cd6af31ef 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -5239,6 +5239,10 @@ export namespace dialogflow_v2beta1 { * The resource name of the existing created generator. Format: `projects//locations//generators/` */ generatorName?: string | null; + /** + * Optional. Name of the CX SecuritySettings which is used to redact generated response. If this field is empty, try to fetch v2 security_settings, which is a project level setting. If this field is empty and no v2 security_settings set up in this project, no redaction will be done. Format: `projects//locations//securitySettings/`. + */ + securitySettings?: string | null; /** * Optional. A list of trigger events. Generator will be triggered only if it's trigger event is included here. */ diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index ca78869c1b..4a9aa78791 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -986,6 +986,40 @@ export namespace discoveryengine_v1 { */ targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[]; } + /** + * Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of user licenses that failed to be updated. + */ + failureCount?: string | null; + /** + * Count of user licenses successfully updated. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for UserLicenseService.BatchUpdateUserLicenses method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * UserLicenses successfully updated. + */ + userLicenses?: Schema$GoogleCloudDiscoveryengineV1alphaUserLicense[]; + } /** * Configurations used to enable CMEK data encryption with Cloud KMS keys. */ @@ -1227,7 +1261,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * Promote certain links based on predefined trigger queries. This now only supports basic site search. + * Promote certain links based on predefined trigger queries. */ promoteAction?: Schema$GoogleCloudDiscoveryengineV1alphaControlPromoteAction; /** @@ -1454,7 +1488,7 @@ export namespace discoveryengine_v1 { */ alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig[]; /** - * Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. + * Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs */ autoRunDisabled?: boolean | null; /** @@ -1470,9 +1504,13 @@ export namespace discoveryengine_v1 { */ connectorModes?: string[] | null; /** - * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system. + * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */ connectorType?: string | null; + /** + * Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. + */ + createEuaSaas?: boolean | null; /** * Output only. Timestamp the DataConnector was created at. */ @@ -1505,6 +1543,14 @@ export namespace discoveryengine_v1 { * The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. */ identityScheduleConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig; + /** + * Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. + */ + incrementalRefreshInterval?: string | null; + /** + * Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. + */ + incrementalSyncDisabled?: boolean | null; /** * Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. */ @@ -1690,7 +1736,7 @@ export namespace discoveryengine_v1 { */ languageInfo?: Schema$GoogleCloudDiscoveryengineV1alphaLanguageInfo; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** @@ -1748,7 +1794,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore { /** - * If set true, the DataStore will not be available for serving search requests. + * Optional. If set true, the DataStore will not be available for serving search requests. */ disabledForServing?: boolean | null; } @@ -2077,7 +2123,7 @@ export namespace discoveryengine_v1 { */ createTime?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; /** @@ -2089,7 +2135,7 @@ export namespace discoveryengine_v1 { */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */ industryVertical?: string | null; /** @@ -2097,7 +2143,7 @@ export namespace discoveryengine_v1 { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -3631,6 +3677,10 @@ export namespace discoveryengine_v1 { * Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec; + /** + * Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + */ + customSearchOperators?: string | null; /** * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ @@ -4145,6 +4195,43 @@ export namespace discoveryengine_v1 { */ userId?: string | null; } + /** + * User License information assigned by the admin. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUserLicense { + /** + * Output only. User created timestamp. + */ + createTime?: string | null; + /** + * Output only. User last logged in time. If the user has not logged in yet, this field will be empty. + */ + lastLoginTime?: string | null; + /** + * Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user; + */ + licenseAssignmentState?: string | null; + /** + * Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. + */ + licenseConfig?: string | null; + /** + * Output only. User update timestamp. + */ + updateTime?: string | null; + /** + * Optional. The full resource name of the User, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}/users/{user_id\}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created. + */ + user?: string | null; + /** + * Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal. + */ + userPrincipal?: string | null; + /** + * Optional. The user profile. We user user full name(First name + Last name) as user profile. + */ + userProfile?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -5081,6 +5168,36 @@ export namespace discoveryengine_v1 { */ uri?: string | null; } + /** + * Request message for UserLicenseService.BatchUpdateUserLicenses method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest { + /** + * Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state. + */ + deleteUnassignedUserLicenses?: boolean | null; + /** + * Cloud Storage location for the input content. + */ + gcsSource?: Schema$GoogleCloudDiscoveryengineV1GcsSource; + /** + * The inline source for the input content for document embeddings. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource; + } + /** + * The inline source for the input config for BatchUpdateUserLicenses method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource { + /** + * Optional. The list of fields to update. + */ + updateMask?: string | null; + /** + * Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal. + */ + userLicenses?: Schema$GoogleCloudDiscoveryengineV1UserLicense[]; + } /** * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. */ @@ -5229,7 +5346,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * Promote certain links based on predefined trigger queries. This now only supports basic site search. + * Promote certain links based on predefined trigger queries. */ promoteAction?: Schema$GoogleCloudDiscoveryengineV1betaControlPromoteAction; /** @@ -5495,7 +5612,7 @@ export namespace discoveryengine_v1 { */ languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** @@ -5553,7 +5670,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore { /** - * If set true, the DataStore will not be available for serving search requests. + * Optional. If set true, the DataStore will not be available for serving search requests. */ disabledForServing?: boolean | null; } @@ -5817,7 +5934,7 @@ export namespace discoveryengine_v1 { */ createTime?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; /** @@ -5829,7 +5946,7 @@ export namespace discoveryengine_v1 { */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */ industryVertical?: string | null; /** @@ -5837,7 +5954,7 @@ export namespace discoveryengine_v1 { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -6968,6 +7085,10 @@ export namespace discoveryengine_v1 { * Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; + /** + * Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + */ + customSearchOperators?: string | null; /** * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ @@ -7570,7 +7691,7 @@ export namespace discoveryengine_v1 { */ groundingCheckRequired?: boolean | null; /** - * Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true. + * Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true. */ score?: number | null; /** @@ -7599,6 +7720,10 @@ export namespace discoveryengine_v1 { * Output only. Annotation contents if the current chunk contains annotations. */ annotationContents?: string[] | null; + /** + * Output only. The annotation metadata includes structured content in the current chunk. + */ + annotationMetadata?: Schema$GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata[]; /** * Output only. Metadata of the current chunk. */ @@ -7636,6 +7761,19 @@ export namespace discoveryengine_v1 { */ relevanceScore?: number | null; } + /** + * The annotation metadata includes structured content in the current chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ChunkAnnotationMetadata { + /** + * Output only. Image id is provided if the structured content is based on an image. + */ + imageId?: string | null; + /** + * Output only. The structured content information. + */ + structuredContent?: Schema$GoogleCloudDiscoveryengineV1ChunkStructuredContent; + } /** * Metadata of the current chunk. This field is only populated on SearchService.Search API. */ @@ -7679,6 +7817,19 @@ export namespace discoveryengine_v1 { */ pageStart?: number | null; } + /** + * The structured content information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ChunkStructuredContent { + /** + * Output only. The content of the structured content. + */ + content?: string | null; + /** + * Output only. The structure type of the structured content. + */ + structureType?: string | null; + } /** * Cloud SQL source import data from. */ @@ -7889,7 +8040,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * Promote certain links based on predefined trigger queries. This now only supports basic site search. + * Promote certain links based on predefined trigger queries. */ promoteAction?: Schema$GoogleCloudDiscoveryengineV1ControlPromoteAction; /** @@ -8314,7 +8465,7 @@ export namespace discoveryengine_v1 { */ kmsKeyName?: string | null; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** @@ -8368,7 +8519,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore { /** - * If set true, the DataStore will not be available for serving search requests. + * Optional. If set true, the DataStore will not be available for serving search requests. */ disabledForServing?: boolean | null; } @@ -8779,7 +8930,7 @@ export namespace discoveryengine_v1 { */ createTime?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; /** @@ -8791,7 +8942,7 @@ export namespace discoveryengine_v1 { */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */ industryVertical?: string | null; /** @@ -8799,7 +8950,7 @@ export namespace discoveryengine_v1 { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -9662,6 +9813,19 @@ export namespace discoveryengine_v1 { */ totalSize?: number | null; } + /** + * Response message for UserLicenseService.ListUserLicenses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ListUserLicensesResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * All the customer's UserLicenses. + */ + userLicenses?: Schema$GoogleCloudDiscoveryengineV1UserLicense[]; + } /** * Media-specific user event information. */ @@ -10560,6 +10724,10 @@ export namespace discoveryengine_v1 { * Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ boostSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpec; + /** + * Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + */ + customSearchOperators?: string | null; /** * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ @@ -11541,6 +11709,43 @@ export namespace discoveryengine_v1 { */ userId?: string | null; } + /** + * User License information assigned by the admin. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UserLicense { + /** + * Output only. User created timestamp. + */ + createTime?: string | null; + /** + * Output only. User last logged in time. If the user has not logged in yet, this field will be empty. + */ + lastLoginTime?: string | null; + /** + * Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user; + */ + licenseAssignmentState?: string | null; + /** + * Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. + */ + licenseConfig?: string | null; + /** + * Output only. User update timestamp. + */ + updateTime?: string | null; + /** + * Optional. The full resource name of the User, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}/users/{user_id\}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created. + */ + user?: string | null; + /** + * Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal. + */ + userPrincipal?: string | null; + /** + * Optional. The user profile. We user user full name(First name + Last name) as user profile. + */ + userProfile?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -11916,6 +12121,7 @@ export namespace discoveryengine_v1 { podcasts: Resource$Projects$Locations$Podcasts; rankingConfigs: Resource$Projects$Locations$Rankingconfigs; userEvents: Resource$Projects$Locations$Userevents; + userStores: Resource$Projects$Locations$Userstores; constructor(context: APIRequestContext) { this.context = context; this.cmekConfigs = new Resource$Projects$Locations$Cmekconfigs( @@ -11942,6 +12148,9 @@ export namespace discoveryengine_v1 { this.userEvents = new Resource$Projects$Locations$Userevents( this.context ); + this.userStores = new Resource$Projects$Locations$Userstores( + this.context + ); } /** @@ -13786,7 +13995,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch extends StandardParameters { /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** @@ -22444,7 +22653,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters { /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string; /** @@ -26405,7 +26614,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters { /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** @@ -35386,6 +35595,252 @@ export namespace discoveryengine_v1 { requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent; } + export class Resource$Projects$Locations$Userstores { + context: APIRequestContext; + userLicenses: Resource$Projects$Locations$Userstores$Userlicenses; + constructor(context: APIRequestContext) { + this.context = context; + this.userLicenses = + new Resource$Projects$Locations$Userstores$Userlicenses(this.context); + } + + /** + * Updates the User License. This method is used for batch assign/unassign licenses to users. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options: StreamMethodOptions + ): GaxiosPromise; + batchUpdateUserLicenses( + params?: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options?: MethodOptions + ): GaxiosPromise; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:batchUpdateUserLicenses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses + extends StandardParameters { + /** + * Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest; + } + + export class Resource$Projects$Locations$Userstores$Userlicenses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the User Licenses. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Userstores$Userlicenses$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Userlicenses$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Userlicenses$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Userstores$Userlicenses$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/userLicenses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List + extends StandardParameters { + /** + * Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. + */ + filter?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. + */ + parent?: string; + } + export class Resource$Projects$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 7238ce1baa..81982123d6 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -2164,6 +2164,70 @@ export namespace discoveryengine_v1alpha { */ uri?: string | null; } + /** + * Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of user licenses that failed to be updated. + */ + failureCount?: string | null; + /** + * Count of user licenses successfully updated. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Request message for UserLicenseService.BatchUpdateUserLicenses method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest { + /** + * Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state. + */ + deleteUnassignedUserLicenses?: boolean | null; + /** + * Cloud Storage location for the input content. + */ + gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource; + /** + * The inline source for the input content for document embeddings. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource; + } + /** + * The inline source for the input config for BatchUpdateUserLicenses method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource { + /** + * Optional. The list of fields to update. + */ + updateMask?: string | null; + /** + * Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal. + */ + userLicenses?: Schema$GoogleCloudDiscoveryengineV1alphaUserLicense[]; + } + /** + * Response message for UserLicenseService.BatchUpdateUserLicenses method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * UserLicenses successfully updated. + */ + userLicenses?: Schema$GoogleCloudDiscoveryengineV1alphaUserLicense[]; + } /** * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. */ @@ -2349,7 +2413,7 @@ export namespace discoveryengine_v1alpha { */ groundingCheckRequired?: boolean | null; /** - * Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true. + * Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true. */ score?: number | null; /** @@ -2441,6 +2505,10 @@ export namespace discoveryengine_v1alpha { * Output only. Annotation contents if the current chunk contains annotations. */ annotationContents?: string[] | null; + /** + * Output only. The annotation metadata includes structured content in the current chunk. + */ + annotationMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata[]; /** * Output only. Metadata of the current chunk. */ @@ -2478,6 +2546,19 @@ export namespace discoveryengine_v1alpha { */ relevanceScore?: number | null; } + /** + * The annotation metadata includes structured content in the current chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkAnnotationMetadata { + /** + * Output only. Image id is provided if the structured content is based on an image. + */ + imageId?: string | null; + /** + * Output only. The structured content information. + */ + structuredContent?: Schema$GoogleCloudDiscoveryengineV1alphaChunkStructuredContent; + } /** * Metadata of the current chunk. This field is only populated on SearchService.Search API. */ @@ -2521,6 +2602,19 @@ export namespace discoveryengine_v1alpha { */ pageStart?: number | null; } + /** + * The structured content information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaChunkStructuredContent { + /** + * Output only. The content of the structured content. + */ + content?: string | null; + /** + * Output only. The structure type of the structured content. + */ + structureType?: string | null; + } /** * Cloud SQL source import data from. */ @@ -2863,7 +2957,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Promote certain links based on predefined trigger queries. This now only supports basic site search. + * Promote certain links based on predefined trigger queries. */ promoteAction?: Schema$GoogleCloudDiscoveryengineV1alphaControlPromoteAction; /** @@ -3270,7 +3364,7 @@ export namespace discoveryengine_v1alpha { */ alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig[]; /** - * Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. + * Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs */ autoRunDisabled?: boolean | null; /** @@ -3286,9 +3380,13 @@ export namespace discoveryengine_v1alpha { */ connectorModes?: string[] | null; /** - * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system. + * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */ connectorType?: string | null; + /** + * Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. + */ + createEuaSaas?: boolean | null; /** * Output only. Timestamp the DataConnector was created at. */ @@ -3321,6 +3419,14 @@ export namespace discoveryengine_v1alpha { * The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. */ identityScheduleConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig; + /** + * Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. + */ + incrementalRefreshInterval?: string | null; + /** + * Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. + */ + incrementalSyncDisabled?: boolean | null; /** * Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. */ @@ -3506,7 +3612,7 @@ export namespace discoveryengine_v1alpha { */ languageInfo?: Schema$GoogleCloudDiscoveryengineV1alphaLanguageInfo; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** @@ -3564,7 +3670,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore { /** - * If set true, the DataStore will not be available for serving search requests. + * Optional. If set true, the DataStore will not be available for serving search requests. */ disabledForServing?: boolean | null; } @@ -4057,7 +4163,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; /** @@ -4069,7 +4175,7 @@ export namespace discoveryengine_v1alpha { */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */ industryVertical?: string | null; /** @@ -4077,7 +4183,7 @@ export namespace discoveryengine_v1alpha { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -5497,6 +5603,19 @@ export namespace discoveryengine_v1alpha { */ totalSize?: number | null; } + /** + * Response message for UserLicenseService.ListUserLicenses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * All the customer's UserLicenses. + */ + userLicenses?: Schema$GoogleCloudDiscoveryengineV1alphaUserLicense[]; + } /** * Media-specific user event information. */ @@ -6974,6 +7093,10 @@ export namespace discoveryengine_v1alpha { * Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec; + /** + * Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + */ + customSearchOperators?: string | null; /** * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ @@ -7311,24 +7434,11 @@ export namespace discoveryengine_v1alpha { * Rewritten input query minus the extracted filters. */ rewrittenQuery?: string | null; - /** - * Optional. The SQL request that was generated from the natural language query understanding phase. - */ - sqlRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest; /** * The filters that were extracted from the input query represented in a structured form. */ structuredExtractedFilter?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter; } - /** - * The SQL request that was generated from the natural language query understanding phase. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest { - /** - * Optional. The SQL query in text format. - */ - sqlQuery?: string | null; - } /** * The filters that were extracted from the input query represented in a structured form. */ @@ -8441,6 +8551,43 @@ export namespace discoveryengine_v1alpha { */ userId?: string | null; } + /** + * User License information assigned by the admin. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUserLicense { + /** + * Output only. User created timestamp. + */ + createTime?: string | null; + /** + * Output only. User last logged in time. If the user has not logged in yet, this field will be empty. + */ + lastLoginTime?: string | null; + /** + * Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user; + */ + licenseAssignmentState?: string | null; + /** + * Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. + */ + licenseConfig?: string | null; + /** + * Output only. User update timestamp. + */ + updateTime?: string | null; + /** + * Optional. The full resource name of the User, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}/users/{user_id\}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created. + */ + user?: string | null; + /** + * Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal. + */ + userPrincipal?: string | null; + /** + * Optional. The user profile. We user user full name(First name + Last name) as user profile. + */ + userProfile?: string | null; + } /** * WidgetConfig captures configs at the Widget level. */ @@ -8505,6 +8652,10 @@ export namespace discoveryengine_v1alpha { * Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). */ enableConversationalSearch?: boolean | null; + /** + * Optional. Output only. Whether to enable private knowledge graph. + */ + enablePrivateKnowledgeGraph?: boolean | null; /** * Turn on or off collecting the search result quality feedback from end users. */ @@ -9125,7 +9276,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Promote certain links based on predefined trigger queries. This now only supports basic site search. + * Promote certain links based on predefined trigger queries. */ promoteAction?: Schema$GoogleCloudDiscoveryengineV1betaControlPromoteAction; /** @@ -9391,7 +9542,7 @@ export namespace discoveryengine_v1alpha { */ languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** @@ -9449,7 +9600,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore { /** - * If set true, the DataStore will not be available for serving search requests. + * Optional. If set true, the DataStore will not be available for serving search requests. */ disabledForServing?: boolean | null; } @@ -9713,7 +9864,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; /** @@ -9725,7 +9876,7 @@ export namespace discoveryengine_v1alpha { */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */ industryVertical?: string | null; /** @@ -9733,7 +9884,7 @@ export namespace discoveryengine_v1alpha { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -10864,6 +11015,10 @@ export namespace discoveryengine_v1alpha { * Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; + /** + * Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + */ + customSearchOperators?: string | null; /** * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ @@ -11394,7 +11549,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Promote certain links based on predefined trigger queries. This now only supports basic site search. + * Promote certain links based on predefined trigger queries. */ promoteAction?: Schema$GoogleCloudDiscoveryengineV1ControlPromoteAction; /** @@ -11643,7 +11798,7 @@ export namespace discoveryengine_v1alpha { */ kmsKeyName?: string | null; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** @@ -11697,7 +11852,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore { /** - * If set true, the DataStore will not be available for serving search requests. + * Optional. If set true, the DataStore will not be available for serving search requests. */ disabledForServing?: boolean | null; } @@ -11953,7 +12108,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; /** @@ -11965,7 +12120,7 @@ export namespace discoveryengine_v1alpha { */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */ industryVertical?: string | null; /** @@ -11973,7 +12128,7 @@ export namespace discoveryengine_v1alpha { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -12990,10 +13145,6 @@ export namespace discoveryengine_v1alpha { * Media upload request metadata. */ mediaRequestInfo?: Schema$ApiservingMediaRequestInfo; - /** - * The project (notebook) id of the uploaded source. Prefer to use the parent field instead. - */ - projectId?: string | null; /** * The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created. */ @@ -13728,6 +13879,7 @@ export namespace discoveryengine_v1alpha { evaluations: Resource$Projects$Locations$Evaluations; groundingConfigs: Resource$Projects$Locations$Groundingconfigs; identityMappingStores: Resource$Projects$Locations$Identitymappingstores; + notebooks: Resource$Projects$Locations$Notebooks; operations: Resource$Projects$Locations$Operations; podcasts: Resource$Projects$Locations$Podcasts; rankingConfigs: Resource$Projects$Locations$Rankingconfigs; @@ -13754,6 +13906,7 @@ export namespace discoveryengine_v1alpha { ); this.identityMappingStores = new Resource$Projects$Locations$Identitymappingstores(this.context); + this.notebooks = new Resource$Projects$Locations$Notebooks(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -17565,7 +17718,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch extends StandardParameters { /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** @@ -27556,7 +27709,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters { /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string; /** @@ -32218,7 +32371,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters { /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** @@ -41769,6 +41922,139 @@ export namespace discoveryengine_v1alpha { pageToken?: string; } + export class Resource$Projects$Locations$Notebooks { + context: APIRequestContext; + sources: Resource$Projects$Locations$Notebooks$Sources; + constructor(context: APIRequestContext) { + this.context = context; + this.sources = new Resource$Projects$Locations$Notebooks$Sources( + this.context + ); + } + } + + export class Resource$Projects$Locations$Notebooks$Sources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Uploads a file for Notebook LM to use. Creates a Source. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + uploadFile( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + options: StreamMethodOptions + ): GaxiosPromise; + uploadFile( + params?: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + options?: MethodOptions + ): GaxiosPromise; + uploadFile( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadFile( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadFile( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + callback: BodyResponseCallback + ): void; + uploadFile( + callback: BodyResponseCallback + ): void; + uploadFile( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/sources/{sourceId}:uploadFile' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent', 'sourceId'], + pathParams: ['parent', 'sourceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile + extends StandardParameters { + /** + * Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + */ + parent?: string; + /** + * The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created. + */ + sourceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaUploadSourceFileRequest; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -44017,14 +44303,126 @@ export namespace discoveryengine_v1alpha { export class Resource$Projects$Locations$Userstores { context: APIRequestContext; operations: Resource$Projects$Locations$Userstores$Operations; + userLicenses: Resource$Projects$Locations$Userstores$Userlicenses; constructor(context: APIRequestContext) { this.context = context; this.operations = new Resource$Projects$Locations$Userstores$Operations( this.context ); + this.userLicenses = + new Resource$Projects$Locations$Userstores$Userlicenses(this.context); + } + + /** + * Updates the User License. This method is used for batch assign/unassign licenses to users. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options: StreamMethodOptions + ): GaxiosPromise; + batchUpdateUserLicenses( + params?: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options?: MethodOptions + ): GaxiosPromise; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}:batchUpdateUserLicenses' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } } + export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses + extends StandardParameters { + /** + * Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest; + } + export class Resource$Projects$Locations$Userstores$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -44252,6 +44650,132 @@ export namespace discoveryengine_v1alpha { pageToken?: string; } + export class Resource$Projects$Locations$Userstores$Userlicenses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the User Licenses. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Userstores$Userlicenses$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Userlicenses$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Userlicenses$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Userstores$Userlicenses$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/userLicenses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List + extends StandardParameters { + /** + * Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. + */ + filter?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. + */ + parent?: string; + } + export class Resource$Projects$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 17ea0eb697..b9fe262dbb 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -957,6 +957,40 @@ export namespace discoveryengine_v1beta { */ targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[]; } + /** + * Metadata related to the progress of the UserLicenseService.BatchUpdateUserLicenses operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of user licenses that failed to be updated. + */ + failureCount?: string | null; + /** + * Count of user licenses successfully updated. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for UserLicenseService.BatchUpdateUserLicenses method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * UserLicenses successfully updated. + */ + userLicenses?: Schema$GoogleCloudDiscoveryengineV1alphaUserLicense[]; + } /** * Configurations used to enable CMEK data encryption with Cloud KMS keys. */ @@ -1198,7 +1232,7 @@ export namespace discoveryengine_v1beta { */ name?: string | null; /** - * Promote certain links based on predefined trigger queries. This now only supports basic site search. + * Promote certain links based on predefined trigger queries. */ promoteAction?: Schema$GoogleCloudDiscoveryengineV1alphaControlPromoteAction; /** @@ -1425,7 +1459,7 @@ export namespace discoveryengine_v1beta { */ alertPolicyConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig[]; /** - * Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. + * Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs */ autoRunDisabled?: boolean | null; /** @@ -1441,9 +1475,13 @@ export namespace discoveryengine_v1beta { */ connectorModes?: string[] | null; /** - * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system. + * Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */ connectorType?: string | null; + /** + * Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. + */ + createEuaSaas?: boolean | null; /** * Output only. Timestamp the DataConnector was created at. */ @@ -1476,6 +1514,14 @@ export namespace discoveryengine_v1beta { * The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. */ identityScheduleConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig; + /** + * Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. + */ + incrementalRefreshInterval?: string | null; + /** + * Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. + */ + incrementalSyncDisabled?: boolean | null; /** * Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. */ @@ -1661,7 +1707,7 @@ export namespace discoveryengine_v1beta { */ languageInfo?: Schema$GoogleCloudDiscoveryengineV1alphaLanguageInfo; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** @@ -1719,7 +1765,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore { /** - * If set true, the DataStore will not be available for serving search requests. + * Optional. If set true, the DataStore will not be available for serving search requests. */ disabledForServing?: boolean | null; } @@ -2048,7 +2094,7 @@ export namespace discoveryengine_v1beta { */ createTime?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; /** @@ -2060,7 +2106,7 @@ export namespace discoveryengine_v1beta { */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */ industryVertical?: string | null; /** @@ -2068,7 +2114,7 @@ export namespace discoveryengine_v1beta { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -3602,6 +3648,10 @@ export namespace discoveryengine_v1beta { * Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec; + /** + * Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + */ + customSearchOperators?: string | null; /** * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ @@ -4116,6 +4166,43 @@ export namespace discoveryengine_v1beta { */ userId?: string | null; } + /** + * User License information assigned by the admin. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUserLicense { + /** + * Output only. User created timestamp. + */ + createTime?: string | null; + /** + * Output only. User last logged in time. If the user has not logged in yet, this field will be empty. + */ + lastLoginTime?: string | null; + /** + * Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user; + */ + licenseAssignmentState?: string | null; + /** + * Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. + */ + licenseConfig?: string | null; + /** + * Output only. User update timestamp. + */ + updateTime?: string | null; + /** + * Optional. The full resource name of the User, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}/users/{user_id\}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created. + */ + user?: string | null; + /** + * Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal. + */ + userPrincipal?: string | null; + /** + * Optional. The user profile. We user user full name(First name + Last name) as user profile. + */ + userProfile?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -5422,6 +5509,36 @@ export namespace discoveryengine_v1beta { */ uri?: string | null; } + /** + * Request message for UserLicenseService.BatchUpdateUserLicenses method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest { + /** + * Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state. + */ + deleteUnassignedUserLicenses?: boolean | null; + /** + * Cloud Storage location for the input content. + */ + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + /** + * The inline source for the input content for document embeddings. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource; + } + /** + * The inline source for the input config for BatchUpdateUserLicenses method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource { + /** + * Optional. The list of fields to update. + */ + updateMask?: string | null; + /** + * Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal. + */ + userLicenses?: Schema$GoogleCloudDiscoveryengineV1betaUserLicense[]; + } /** * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. */ @@ -5607,7 +5724,7 @@ export namespace discoveryengine_v1beta { */ groundingCheckRequired?: boolean | null; /** - * Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true. + * Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true. */ score?: number | null; /** @@ -5636,6 +5753,10 @@ export namespace discoveryengine_v1beta { * Output only. Annotation contents if the current chunk contains annotations. */ annotationContents?: string[] | null; + /** + * Output only. The annotation metadata includes structured content in the current chunk. + */ + annotationMetadata?: Schema$GoogleCloudDiscoveryengineV1betaChunkAnnotationMetadata[]; /** * Output only. Metadata of the current chunk. */ @@ -5673,6 +5794,19 @@ export namespace discoveryengine_v1beta { */ relevanceScore?: number | null; } + /** + * The annotation metadata includes structured content in the current chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaChunkAnnotationMetadata { + /** + * Output only. Image id is provided if the structured content is based on an image. + */ + imageId?: string | null; + /** + * Output only. The structured content information. + */ + structuredContent?: Schema$GoogleCloudDiscoveryengineV1betaChunkStructuredContent; + } /** * Metadata of the current chunk. This field is only populated on SearchService.Search API. */ @@ -5716,6 +5850,19 @@ export namespace discoveryengine_v1beta { */ pageStart?: number | null; } + /** + * The structured content information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaChunkStructuredContent { + /** + * Output only. The content of the structured content. + */ + content?: string | null; + /** + * Output only. The structure type of the structured content. + */ + structureType?: string | null; + } /** * Cloud SQL source import data from. */ @@ -5926,7 +6073,7 @@ export namespace discoveryengine_v1beta { */ name?: string | null; /** - * Promote certain links based on predefined trigger queries. This now only supports basic site search. + * Promote certain links based on predefined trigger queries. */ promoteAction?: Schema$GoogleCloudDiscoveryengineV1betaControlPromoteAction; /** @@ -6372,7 +6519,7 @@ export namespace discoveryengine_v1beta { */ languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** @@ -6430,7 +6577,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore { /** - * If set true, the DataStore will not be available for serving search requests. + * Optional. If set true, the DataStore will not be available for serving search requests. */ disabledForServing?: boolean | null; } @@ -6858,7 +7005,7 @@ export namespace discoveryengine_v1beta { */ createTime?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; /** @@ -6870,7 +7017,7 @@ export namespace discoveryengine_v1beta { */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */ industryVertical?: string | null; /** @@ -6878,7 +7025,7 @@ export namespace discoveryengine_v1beta { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -7967,6 +8114,19 @@ export namespace discoveryengine_v1beta { */ totalSize?: number | null; } + /** + * Response message for UserLicenseService.ListUserLicenses. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListUserLicensesResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * All the customer's UserLicenses. + */ + userLicenses?: Schema$GoogleCloudDiscoveryengineV1betaUserLicense[]; + } /** * Media-specific user event information. */ @@ -9147,6 +9307,10 @@ export namespace discoveryengine_v1beta { * Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; + /** + * Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + */ + customSearchOperators?: string | null; /** * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ @@ -9484,24 +9648,11 @@ export namespace discoveryengine_v1beta { * Rewritten input query minus the extracted filters. */ rewrittenQuery?: string | null; - /** - * Optional. The SQL request that was generated from the natural language query understanding phase. - */ - sqlRequest?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest; /** * The filters that were extracted from the input query represented in a structured form. */ structuredExtractedFilter?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter; } - /** - * The SQL request that was generated from the natural language query understanding phase. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest { - /** - * Optional. The SQL query in text format. - */ - sqlQuery?: string | null; - } /** * The filters that were extracted from the input query represented in a structured form. */ @@ -10487,6 +10638,43 @@ export namespace discoveryengine_v1beta { */ userId?: string | null; } + /** + * User License information assigned by the admin. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUserLicense { + /** + * Output only. User created timestamp. + */ + createTime?: string | null; + /** + * Output only. User last logged in time. If the user has not logged in yet, this field will be empty. + */ + lastLoginTime?: string | null; + /** + * Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user; + */ + licenseAssignmentState?: string | null; + /** + * Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. + */ + licenseConfig?: string | null; + /** + * Output only. User update timestamp. + */ + updateTime?: string | null; + /** + * Optional. The full resource name of the User, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}/users/{user_id\}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created. + */ + user?: string | null; + /** + * Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal. + */ + userPrincipal?: string | null; + /** + * Optional. The user profile. We user user full name(First name + Last name) as user profile. + */ + userProfile?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -10617,7 +10805,7 @@ export namespace discoveryengine_v1beta { */ name?: string | null; /** - * Promote certain links based on predefined trigger queries. This now only supports basic site search. + * Promote certain links based on predefined trigger queries. */ promoteAction?: Schema$GoogleCloudDiscoveryengineV1ControlPromoteAction; /** @@ -10866,7 +11054,7 @@ export namespace discoveryengine_v1beta { */ kmsKeyName?: string | null; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** @@ -10920,7 +11108,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore { /** - * If set true, the DataStore will not be available for serving search requests. + * Optional. If set true, the DataStore will not be available for serving search requests. */ disabledForServing?: boolean | null; } @@ -11176,7 +11364,7 @@ export namespace discoveryengine_v1beta { */ createTime?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; /** @@ -11188,7 +11376,7 @@ export namespace discoveryengine_v1beta { */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */ industryVertical?: string | null; /** @@ -11196,7 +11384,7 @@ export namespace discoveryengine_v1beta { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -12548,6 +12736,7 @@ export namespace discoveryengine_v1beta { rankingConfigs: Resource$Projects$Locations$Rankingconfigs; sampleQuerySets: Resource$Projects$Locations$Samplequerysets; userEvents: Resource$Projects$Locations$Userevents; + userStores: Resource$Projects$Locations$Userstores; constructor(context: APIRequestContext) { this.context = context; this.cmekConfigs = new Resource$Projects$Locations$Cmekconfigs( @@ -12580,6 +12769,9 @@ export namespace discoveryengine_v1beta { this.userEvents = new Resource$Projects$Locations$Userevents( this.context ); + this.userStores = new Resource$Projects$Locations$Userstores( + this.context + ); } /** @@ -14754,7 +14946,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch extends StandardParameters { /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** @@ -24049,7 +24241,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters { /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string; /** @@ -28394,7 +28586,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters { /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** @@ -39592,6 +39784,251 @@ export namespace discoveryengine_v1beta { requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; } + export class Resource$Projects$Locations$Userstores { + context: APIRequestContext; + userLicenses: Resource$Projects$Locations$Userstores$Userlicenses; + constructor(context: APIRequestContext) { + this.context = context; + this.userLicenses = + new Resource$Projects$Locations$Userstores$Userlicenses(this.context); + } + + /** + * Updates the User License. This method is used for batch assign/unassign licenses to users. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options: StreamMethodOptions + ): GaxiosPromise; + batchUpdateUserLicenses( + params?: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options?: MethodOptions + ): GaxiosPromise; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + callback: BodyResponseCallback + ): void; + batchUpdateUserLicenses( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta/{+parent}:batchUpdateUserLicenses' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses + extends StandardParameters { + /** + * Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest; + } + + export class Resource$Projects$Locations$Userstores$Userlicenses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the User Licenses. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Userstores$Userlicenses$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Userstores$Userlicenses$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Userlicenses$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Userlicenses$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Userstores$Userlicenses$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/userLicenses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List + extends StandardParameters { + /** + * Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. + */ + filter?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. + */ + parent?: string; + } + export class Resource$Projects$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 4b5f13aa6b..0e3688da75 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -1556,7 +1556,7 @@ export namespace dlp_v2 { timeZone?: Schema$GooglePrivacyDlpV2TimeZone; } /** - * Create a de-identified copy of the requested table or files. A TransformationDetail will be created for each transformation. If any rows in BigQuery are skipped during de-identification (transformation errors or row size exceeds BigQuery insert API limits) they are placed in the failure output table. If the original row exceeds the BigQuery insert API limit it will be truncated when written to the failure output table. The failure output table can be set in the action.deidentify.output.big_query_output.deidentified_failure_output_table field, if no table is set, a table will be automatically created in the same project and dataset as the original table. Compatible with: Inspect + * Create a de-identified copy of a storage bucket. Only compatible with Cloud Storage buckets. A TransformationDetail will be created for each transformation. Compatible with: Inspection of Cloud Storage */ export interface Schema$GooglePrivacyDlpV2Deidentify { /** @@ -1572,7 +1572,7 @@ export namespace dlp_v2 { */ transformationConfig?: Schema$GooglePrivacyDlpV2TransformationConfig; /** - * Config for storing transformation details. This is separate from the de-identified content, and contains metadata about the successful transformations and/or failures that occurred while de-identifying. This needs to be set in order for users to access information about the status of each transformation (see TransformationDetails message for more information about what is noted). + * Config for storing transformation details. This field specifies the configuration for storing detailed metadata about each transformation performed during a de-identification process. The metadata is stored separately from the de-identified content itself and provides a granular record of both successful transformations and any failures that occurred. Enabling this configuration is essential for users who need to access comprehensive information about the status, outcome, and specifics of each transformation. The details are captured in the TransformationDetails message for each operation. Key use cases: * **Auditing and compliance** * Provides a verifiable audit trail of de-identification activities, which is crucial for meeting regulatory requirements and internal data governance policies. * Logs what data was transformed, what transformations were applied, when they occurred, and their success status. This helps demonstrate accountability and due diligence in protecting sensitive data. * **Troubleshooting and debugging** * Offers detailed error messages and context if a transformation fails. This information is useful for diagnosing and resolving issues in the de-identification pipeline. * Helps pinpoint the exact location and nature of failures, speeding up the debugging process. * **Process verification and quality assurance** * Allows users to confirm that de-identification rules and transformations were applied correctly and consistently across the dataset as intended. * Helps in verifying the effectiveness of the chosen de-identification strategies. * **Data lineage and impact analysis** * Creates a record of how data elements were modified, contributing to data lineage. This is useful for understanding the provenance of de-identified data. * Aids in assessing the potential impact of de-identification choices on downstream analytical processes or data usability. * **Reporting and operational insights** * You can analyze the metadata stored in a queryable BigQuery table to generate reports on transformation success rates, common error types, processing volumes (e.g., transformedBytes), and the types of transformations applied. * These insights can inform optimization of de-identification configurations and resource planning. To take advantage of these benefits, set this configuration. The stored details include a description of the transformation, success or error codes, error messages, the number of bytes transformed, the location of the transformed content, and identifiers for the job and source data. */ transformationDetailsStorageConfig?: Schema$GooglePrivacyDlpV2TransformationDetailsStorageConfig; } @@ -2475,7 +2475,7 @@ export namespace dlp_v2 { */ fileStoreInfoTypeSummaries?: Schema$GooglePrivacyDlpV2FileStoreInfoTypeSummary[]; /** - * The file store does not have any files. If the profiling failed, this will be false. + * The file store does not have any files. If the profiling operation failed, this is false. */ fileStoreIsEmpty?: boolean | null; /** diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index cab48fac34..065dcf0271 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -7709,6 +7709,10 @@ export namespace drive_v2 { * A plain text custom message to include in notification emails. */ emailMessage?: string; + /** + * Whether the request should enforce expansive access rules. + */ + enforceExpansiveAccess?: boolean; /** * Deprecated: See `moveToNewOwnersRoot` for details. */ diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 99e142b22d..e0dc9d8fba 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -2943,7 +2943,7 @@ export namespace drive_v3 { } /** - * Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set. To return the exact fields you need, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). + * Deletes a comment. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6414,6 +6414,10 @@ export namespace drive_v3 { * A plain text custom message to include in the notification email. */ emailMessage?: string; + /** + * Whether the request should enforce expansive access rules. + */ + enforceExpansiveAccess?: boolean; /** * Deprecated: See `moveToNewOwnersRoot` for details. */ diff --git a/src/apis/firebaseapphosting/README.md b/src/apis/firebaseapphosting/README.md new file mode 100644 index 0000000000..756feaacdd --- /dev/null +++ b/src/apis/firebaseapphosting/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# firebaseapphosting + +> Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub integration, and integration with other Firebase products. You can use this API to intervene in the Firebase App Hosting build process and add custom functionality not supported in our default Console & CLI flows, including triggering builds from external CI/CD workflows or deploying from pre-built container images. + +## Installation + +```sh +$ npm install @googleapis/firebaseapphosting +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/firebaseapphosting/classes/Firebaseapphosting.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/firebaseapphosting/index.ts b/src/apis/firebaseapphosting/index.ts new file mode 100644 index 0000000000..0c08ff456a --- /dev/null +++ b/src/apis/firebaseapphosting/index.ts @@ -0,0 +1,65 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {firebaseapphosting_v1} from './v1'; +import {firebaseapphosting_v1beta} from './v1beta'; + +export const VERSIONS = { + v1: firebaseapphosting_v1.Firebaseapphosting, + v1beta: firebaseapphosting_v1beta.Firebaseapphosting, +}; + +export function firebaseapphosting( + version: 'v1' +): firebaseapphosting_v1.Firebaseapphosting; +export function firebaseapphosting( + options: firebaseapphosting_v1.Options +): firebaseapphosting_v1.Firebaseapphosting; +export function firebaseapphosting( + version: 'v1beta' +): firebaseapphosting_v1beta.Firebaseapphosting; +export function firebaseapphosting( + options: firebaseapphosting_v1beta.Options +): firebaseapphosting_v1beta.Firebaseapphosting; +export function firebaseapphosting< + T = + | firebaseapphosting_v1.Firebaseapphosting + | firebaseapphosting_v1beta.Firebaseapphosting, +>( + this: GoogleConfigurable, + versionOrOptions: + | 'v1' + | firebaseapphosting_v1.Options + | 'v1beta' + | firebaseapphosting_v1beta.Options +) { + return getAPI('firebaseapphosting', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {firebaseapphosting_v1}; +export {firebaseapphosting_v1beta}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/firebaseapphosting/package.json b/src/apis/firebaseapphosting/package.json new file mode 100644 index 0000000000..c37c95e8d0 --- /dev/null +++ b/src/apis/firebaseapphosting/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/firebaseapphosting", + "version": "0.1.0", + "description": "firebaseapphosting", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/firebaseapphosting/tsconfig.json b/src/apis/firebaseapphosting/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/firebaseapphosting/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/firebaseapphosting/v1.ts b/src/apis/firebaseapphosting/v1.ts new file mode 100644 index 0000000000..aee1725437 --- /dev/null +++ b/src/apis/firebaseapphosting/v1.ts @@ -0,0 +1,3821 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace firebaseapphosting_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Firebase App Hosting API + * + * Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub integration, and integration with other Firebase products. You can use this API to intervene in the Firebase App Hosting build process and add custom functionality not supported in our default Console & CLI flows, including triggering builds from external CI/CD workflows or deploying from pre-built container images. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const firebaseapphosting = google.firebaseapphosting('v1'); + * ``` + */ + export class Firebaseapphosting { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * A backend is the primary resource of App Hosting. + */ + export interface Schema$Backend { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. + */ + annotations?: {[key: string]: string} | null; + /** + * Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend. + */ + appId?: string | null; + /** + * Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend. + */ + codebase?: Schema$Codebase; + /** + * Output only. Time at which the backend was created. + */ + createTime?: string | null; + /** + * Output only. Time at which the backend was deleted. + */ + deleteTime?: string | null; + /** + * Optional. Human-readable name. 63 character limit. + */ + displayName?: string | null; + /** + * Optional. The environment name of the backend, used to load environment variables from environment specific configuration. + */ + environment?: string | null; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. A list of the resources managed by this backend. + */ + managedResources?: Schema$ManagedResource[]; + /** + * Optional. Deprecated: Use `environment` instead. + */ + mode?: string | null; + /** + * Identifier. The resource name of the backend. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + name?: string | null; + /** + * Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. + */ + reconciling?: boolean | null; + /** + * Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. + */ + serviceAccount?: string | null; + /** + * Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS). + */ + servingLocality?: string | null; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the backend was last updated. + */ + updateTime?: string | null; + /** + * Output only. The primary URI to communicate with the backend. + */ + uri?: string | null; + } + /** + * A single build for a backend, at a specific point codebase reference tag and point in time. Encapsulates several resources, including an Artifact Registry container image, a Cloud Build invocation that built the image, and the Cloud Run revision that uses that image. + */ + export interface Schema$Build { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. + */ + buildLogsUri?: string | null; + /** + * Optional. Additional configuration of the service. + */ + config?: Schema$Config; + /** + * Output only. Time at which the build was created. + */ + createTime?: string | null; + /** + * Output only. Time at which the build was deleted. + */ + deleteTime?: string | null; + /** + * Optional. Human-readable name. 63 character limit. + */ + displayName?: string | null; + /** + * Output only. The environment name of the backend when this build was created. + */ + environment?: string | null; + /** + * Output only. A list of all errors that occurred during an App Hosting build. + */ + errors?: Schema$Error[]; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Output only. The Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) URI, used by the Cloud Run [`revision`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services.revisions) for this build. + */ + image?: string | null; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the build. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/builds/{buildId\}`. + */ + name?: string | null; + /** + * Output only. A field that, if true, indicates that the build has an ongoing LRO. + */ + reconciling?: boolean | null; + /** + * Required. Immutable. The source for the build. + */ + source?: Schema$BuildSource; + /** + * Output only. The state of the build. + */ + state?: string | null; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the build was last updated. + */ + updateTime?: string | null; + } + /** + * The source for the build. + */ + export interface Schema$BuildSource { + /** + * A codebase source. + */ + codebase?: Schema$CodebaseSource; + /** + * An Artifact Registry container image source. + */ + container?: Schema$ContainerSource; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * The connection to an external source repository to watch for event-driven updates to the backend. + */ + export interface Schema$Codebase { + /** + * Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project\}/locations/{location\}/connections/{connection\}/gitRepositoryLinks/{repositoryLink\}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console. + */ + repository?: string | null; + /** + * Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. + */ + rootDirectory?: string | null; + } + /** + * A codebase source, representing the state of the codebase that the build will be created at. + */ + export interface Schema$CodebaseSource { + /** + * Output only. The author contained in the metadata of a version control change. + */ + author?: Schema$UserMetadata; + /** + * The branch in the codebase to build from, using the latest commit. + */ + branch?: string | null; + /** + * The commit in the codebase to build from. + */ + commit?: string | null; + /** + * Output only. The message of a codebase change. + */ + commitMessage?: string | null; + /** + * Output only. The time the change was made. + */ + commitTime?: string | null; + /** + * Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com. + */ + displayName?: string | null; + /** + * Output only. The full SHA-1 hash of a Git commit, if available. + */ + hash?: string | null; + /** + * Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository. + */ + uri?: string | null; + } + /** + * Additional configuration of the backend for this build. + */ + export interface Schema$Config { + /** + * Optional. Environment variables for this build. + */ + env?: Schema$EnvironmentVariable[]; + /** + * Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). + */ + runConfig?: Schema$RunConfig; + } + /** + * The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. + */ + export interface Schema$ContainerSource { + /** + * Required. A URI representing a container for the backend to use. + */ + image?: string | null; + } + /** + * Additional metadata for operations on custom domains. + */ + export interface Schema$CustomDomainOperationMetadata { + /** + * Output only. The custom domain's `CertState`, which must be `CERT_ACTIVE` for the create operations to complete. + */ + certState?: string | null; + /** + * Output only. The custom domain's `HostState`, which must be `HOST_ACTIVE` for Create operations of the domain name this `CustomDomain` refers toto complete. + */ + hostState?: string | null; + /** + * Output only. A list of issues that are currently preventing the operation from completing. These are generally DNS-related issues encountered when querying a domain's records or attempting to mint an SSL certificate. + */ + issues?: Schema$Status[]; + /** + * Output only. A list of steps that the user must complete to migrate their domain to App Hosting without downtime. + */ + liveMigrationSteps?: Schema$LiveMigrationStep[]; + /** + * Output only. The custom domain's `OwnershipState`, which must be `OWNERSHIP_ACTIVE` for the create operations to complete. + */ + ownershipState?: string | null; + /** + * Output only. A set of DNS record updates to perform, to allow App Hosting to serve secure content on the domain. + */ + quickSetupUpdates?: Schema$DnsUpdates[]; + } + /** + * The status of a custom domain's linkage to a backend. + */ + export interface Schema$CustomDomainStatus { + /** + * Output only. Tracks SSL certificate status for the domain. + */ + certState?: string | null; + /** + * Output only. Tracks whether a custom domain is detected as appropriately directing traffic to App Hosting. + */ + hostState?: string | null; + /** + * Output only. A list of issues with domain configuration. Allows users to self-correct problems with DNS records. + */ + issues?: Schema$Status[]; + /** + * Output only. Tracks whether the backend is permitted to serve content on the domain, based off the domain's DNS records. + */ + ownershipState?: string | null; + /** + * Output only. Lists the records that must added or removed to a custom domain's DNS in order to finish setup and start serving content. Field is present during onboarding. Also present after onboarding if one or more of the above states is not *_ACTIVE, indicating the domain's DNS records are in a bad state. + */ + requiredDnsUpdates?: Schema$DnsUpdates[]; + } + /** + * A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). + */ + export interface Schema$DnsRecord { + /** + * Output only. The domain the record pertains to, e.g. `foo.bar.com.`. + */ + domainName?: string | null; + /** + * Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. + */ + rdata?: string | null; + /** + * Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. + */ + relevantState?: string[] | null; + /** + * Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. + */ + requiredAction?: string | null; + /** + * Output only. The record's type, which determines what data the record contains. + */ + type?: string | null; + } + /** + * A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. + */ + export interface Schema$DnsRecordSet { + /** + * Output only. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. + */ + checkError?: Schema$Status; + /** + * Output only. The domain name the record set pertains to. + */ + domainName?: string | null; + /** + * Output only. Records on the domain. + */ + records?: Schema$DnsRecord[]; + } + /** + * A set of DNS record updates that you should make to allow App Hosting to serve secure content in response to requests against your domain. These updates present the current state of your domain's and related subdomains' DNS records when App Hosting last queried them, and the desired set of records that App Hosting needs to see before your custom domain can be fully active. + */ + export interface Schema$DnsUpdates { + /** + * Output only. The last time App Hosting checked your custom domain's DNS records. + */ + checkTime?: string | null; + /** + * Output only. The set of DNS records App Hosting needs in order to be able to serve secure content on the domain. + */ + desired?: Schema$DnsRecordSet[]; + /** + * Output only. The set of DNS records App Hosting discovered when inspecting a domain. + */ + discovered?: Schema$DnsRecordSet[]; + /** + * Output only. The domain name the DNS updates pertain to. + */ + domainName?: string | null; + } + /** + * A domain name that is associated with a backend. + */ + export interface Schema$Domain { + /** + * Optional. Annotations as key value pairs. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. Time at which the domain was created. + */ + createTime?: string | null; + /** + * Output only. Represents the state and configuration of a `CUSTOM` type domain. It is only present on Domains of that type. + */ + customDomainStatus?: Schema$CustomDomainStatus; + /** + * Output only. Time at which the domain was deleted. + */ + deleteTime?: string | null; + /** + * Optional. Whether the domain is disabled. Defaults to false. + */ + disabled?: boolean | null; + /** + * Optional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`. + */ + displayName?: string | null; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com` + */ + name?: string | null; + /** + * Output only. A field that, if true, indicates that the build has an ongoing LRO. + */ + reconciling?: boolean | null; + /** + * Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content. + */ + serve?: Schema$ServingBehavior; + /** + * Output only. The type of the domain. + */ + type?: string | null; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the domain was last updated. + */ + updateTime?: string | null; + } + /** + * Represents the metadata of a long-running operation on domains. + */ + export interface Schema$DomainOperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. Additional metadata for operations on custom domains. + */ + customDomainOperationMetadata?: Schema$CustomDomainOperationMetadata; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * 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 {} + /** + * Environment variables for this build. + */ + export interface Schema$EnvironmentVariable { + /** + * Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + */ + availability?: string[] | null; + /** + * A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + */ + secret?: string | null; + /** + * A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + */ + value?: string | null; + /** + * Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + */ + variable?: string | null; + } + /** + * The container for the rpc status and source for any errors found during the build process. + */ + export interface Schema$Error { + /** + * Output only. Resource link + */ + cloudResource?: string | null; + /** + * Output only. A status and (human readable) error message for the build, if in a `FAILED` state. + */ + error?: Schema$Status; + /** + * Output only. The source of the error for the build, if in a `FAILED` state. + */ + errorSource?: string | null; + } + /** + * Message for response to list backends + */ + export interface Schema$ListBackendsResponse { + /** + * The list of backends + */ + backends?: Schema$Backend[]; + /** + * A token identifying the next page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to list builds. + */ + export interface Schema$ListBuildsResponse { + /** + * The list of builds. + */ + builds?: Schema$Build[]; + /** + * A token identifying the next page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to list domains. + */ + export interface Schema$ListDomainsResponse { + /** + * Output only. The list of domains. + */ + domains?: Schema$Domain[]; + /** + * Output only. A token identifying the next page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Output only. Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * Message for response to list rollouts. + */ + export interface Schema$ListRolloutsResponse { + /** + * A token identifying the next page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of rollouts. + */ + rollouts?: Schema$Rollout[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * A set of updates including ACME challenges and DNS records that allow App Hosting to create an SSL certificate and establish project ownership for your domain name before you direct traffic to App Hosting servers. Use these updates to facilitate zero downtime migrations to App Hosting from other services. After you've made the recommended updates, check your custom domain's `ownershipState` and `certState`. To avoid downtime, they should be `OWNERSHIP_ACTIVE` and `CERT_ACTIVE`, respectively, before you update your `A` and `AAAA` records. + */ + export interface Schema$LiveMigrationStep { + /** + * Output only. DNS updates to facilitate your domain's zero-downtime migration to App Hosting. + */ + dnsUpdates?: Schema$DnsUpdates[]; + /** + * Output only. Issues that prevent the current step from completing. + */ + issues?: Schema$Status[]; + /** + * Output only. One or more states from the `CustomDomainStatus` of the migrating domain that this step is attempting to make ACTIVE. For example, if the step is attempting to mint an SSL certificate, this field will include `CERT_STATE`. + */ + relevantDomainStates?: string[] | null; + /** + * Output only. The state of the live migration step, indicates whether you should work to complete the step now, in the future, or have already completed it. + */ + stepState?: string | null; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * An external resource managed by App Hosting on the project. + */ + export interface Schema$ManagedResource { + /** + * A Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service), managed by App Hosting. + */ + runService?: Schema$RunService; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`. + */ + name?: string | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of a long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * Specifies redirect behavior for a domain. + */ + export interface Schema$Redirect { + /** + * Optional. The status code to use in a redirect response. Must be a valid HTTP 3XX status code. Defaults to 302 if not present. + */ + status?: string | null; + /** + * Required. The URI of the redirect's intended destination. This URI will be prepended to the original request path. URI without a scheme are assumed to be HTTPS. + */ + uri?: string | null; + } + /** + * A single rollout of a build for a backend. + */ + export interface Schema$Rollout { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. + */ + annotations?: {[key: string]: string} | null; + /** + * Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic. + */ + build?: string | null; + /** + * Output only. Time at which the rollout was created. + */ + createTime?: string | null; + /** + * Output only. Time at which the rollout was deleted. + */ + deleteTime?: string | null; + /** + * Optional. Human-readable name. 63 character limit. + */ + displayName?: string | null; + /** + * Output only. A status and (human readable) error message for the rollout, if in a `FAILED` state. + */ + error?: Schema$Status; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the rollout. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/rollouts/{rolloutId\}`. + */ + name?: string | null; + /** + * Output only. A field that, if true, indicates that the Rollout currently has an LRO. + */ + reconciling?: boolean | null; + /** + * Output only. The state of the rollout. + */ + state?: string | null; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the rollout was last updated. + */ + updateTime?: string | null; + } + /** + * The policy for how automatic builds and rollouts are triggered and rolled out. + */ + export interface Schema$RolloutPolicy { + /** + * If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen. + */ + codebaseBranch?: string | null; + /** + * Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy. + */ + disabled?: boolean | null; + /** + * Output only. If `disabled` is set, the time at which the automatic rollouts were disabled. + */ + disabledTime?: string | null; + } + /** + * Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). + */ + export interface Schema$RunConfig { + /** + * Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000. + */ + concurrency?: number | null; + /** + * Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB + */ + cpu?: number | null; + /** + * Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits. + */ + maxInstances?: number | null; + /** + * Optional. Amount of memory allocated for each serving instance in MiB. By default, memory defaults to the Cloud Run's default where each instance is allocated 512 MiB of memory. Memory can be set to any integer value between 128 to 32768. Increasing memory limit may require increase in CPUs limits: - Over 4 GiB: at least 2 CPUs - Over 8 GiB: at least 4 CPUs - Over 16 GiB: at least 6 CPUs - Over 24 GiB: at least 8 CPUs + */ + memoryMib?: number | null; + /** + * Optional. Number of Cloud Run instances to maintain at minimum for each Cloud Run Service. By default, there are no minimum. Even if the service splits traffic across multiple revisions, the total number of instances for a service will be capped at this value. + */ + minInstances?: number | null; + } + /** + * A managed Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). + */ + export interface Schema$RunService { + /** + * Optional. The name of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service), in the format: `projects/{project\}/locations/{location\}/services/{serviceId\}` + */ + service?: string | null; + } + /** + * Indicates whether App Hosting will serve content on the domain. + */ + export interface Schema$ServingBehavior { + /** + * Optional. Redirect behavior for a domain, if provided. + */ + redirect?: Schema$Redirect; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } + /** + * Controls traffic configuration for the backend. + */ + export interface Schema$Traffic { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. Time at which the backend was created. + */ + createTime?: string | null; + /** + * Output only. Current state of traffic allocation for the backend. When setting `target`, this field may differ for some time until the desired state is reached. + */ + current?: Schema$TrafficSet; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the backend's traffic. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/traffic`. + */ + name?: string | null; + /** + * Output only. A field that, if true, indicates that the system is working to make the backend's `current` match the requested `target` list. + */ + reconciling?: boolean | null; + /** + * A rollout policy specifies how new builds and automatic deployments are created. + */ + rolloutPolicy?: Schema$RolloutPolicy; + /** + * Set to manually control the desired traffic for the backend. This will cause `current` to eventually match this value. The percentages must add up to 100%. + */ + target?: Schema$TrafficSet; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the backend was last updated. + */ + updateTime?: string | null; + } + /** + * A list of traffic splits that together represent where traffic is being routed. + */ + export interface Schema$TrafficSet { + /** + * Required. The list of traffic splits. + */ + splits?: Schema$TrafficSplit[]; + } + /** + * The traffic allocation for the backend. + */ + export interface Schema$TrafficSplit { + /** + * Required. The build that traffic is being routed to. + */ + build?: string | null; + /** + * Required. The percentage of traffic to send to the build. Currently must be 100% or 0%. + */ + percent?: number | null; + } + /** + * Version control metadata for a user associated with a resolved codebase. Currently assumes a Git user. + */ + export interface Schema$UserMetadata { + /** + * Output only. The 'name' field in a Git user's git.config. Required by Git. + */ + displayName?: string | null; + /** + * Output only. The 'email' field in a Git user's git.config, if available. + */ + email?: string | null; + /** + * Output only. The URI of an image file associated with the user's account in an external source control provider, if available. + */ + imageUri?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + backends: Resource$Projects$Locations$Backends; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.backends = new Resource$Projects$Locations$Backends(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + + /** + * Gets information about 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. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Backends { + context: APIRequestContext; + builds: Resource$Projects$Locations$Backends$Builds; + domains: Resource$Projects$Locations$Backends$Domains; + rollouts: Resource$Projects$Locations$Backends$Rollouts; + traffic: Resource$Projects$Locations$Backends$Traffic; + constructor(context: APIRequestContext) { + this.context = context; + this.builds = new Resource$Projects$Locations$Backends$Builds( + this.context + ); + this.domains = new Resource$Projects$Locations$Backends$Domains( + this.context + ); + this.rollouts = new Resource$Projects$Locations$Backends$Rollouts( + this.context + ); + this.traffic = new Resource$Projects$Locations$Backends$Traffic( + this.context + ); + } + + /** + * Creates a new backend in a given 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. + */ + create( + params: Params$Resource$Projects$Locations$Backends$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backends$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backends$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backends').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backends$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backends$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists backends in a given 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$Backends$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backends$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backends$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backends').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the information for a single backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backends$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backends$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Create + extends StandardParameters { + /** + * Required. Id of the backend. Also used as the service ID for Cloud Run, and as part of the default domain name. + */ + backendId?: string; + /** + * Required. A parent name of the form `projects/{project\}/locations/{locationId\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Backend; + } + export interface Params$Resource$Projects$Locations$Backends$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error. + */ + etag?: string; + /** + * Optional. If set to true, any resources for this backend will also be deleted. Otherwise, any children resources will block deletion. + */ + force?: boolean; + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated, without persisting the request or updating any resources. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$List + extends StandardParameters { + /** + * Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. + */ + orderBy?: string; + /** + * Optional. The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + /** + * Required. A parent name of the form `projects/{project\}/locations/{locationId\}`. + */ + parent?: string; + /** + * Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. + */ + showDeleted?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Patch + extends StandardParameters { + /** + * Optional. If set to true, and the backend is not found, a new backend will be created. + */ + allowMissing?: boolean; + /** + * Identifier. The resource name of the backend. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the backend resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + /** + * Optional. Indicates that the request should be validated, without persisting the request or updating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Backend; + } + + export class Resource$Projects$Locations$Backends$Builds { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new build for a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Builds$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backends$Builds$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backends$Builds$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Builds$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Builds$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Builds$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Builds$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Builds$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/builds').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single build. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Builds$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backends$Builds$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backends$Builds$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Builds$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Builds$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Builds$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Builds$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Builds$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about a build. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Builds$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Builds$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Builds$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Builds$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Builds$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Builds$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Builds$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Builds$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists builds in a given project, location, and backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Builds$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backends$Builds$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backends$Builds$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Builds$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Builds$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Builds$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Builds$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Builds$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/builds').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Builds$Create + extends StandardParameters { + /** + * Required. Desired ID of the build being created. + */ + buildId?: string; + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Build; + } + export interface Params$Resource$Projects$Locations$Backends$Builds$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error. + */ + etag?: string; + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/builds/{buildId\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Builds$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/builds/{buildId\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$Builds$List + extends StandardParameters { + /** + * Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. + */ + orderBy?: string; + /** + * Optional. The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent backend in the form `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. + */ + showDeleted?: boolean; + } + + export class Resource$Projects$Locations$Backends$Domains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Links a new domain to a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backends$Domains$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backends$Domains$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Domains$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Domains$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Domains$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/domains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single domain. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backends$Domains$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backends$Domains$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Domains$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Domains$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Domains$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about a domain. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Domains$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Domains$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Domains$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Domains$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Domains$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists domains of a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backends$Domains$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backends$Domains$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Domains$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Domains$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Domains$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/domains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the information for a single domain. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backends$Domains$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backends$Domains$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Domains$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Domains$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Domains$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Domains$Create + extends StandardParameters { + /** + * Required. Id of the domain to create. Must be a valid domain name. + */ + domainId?: string; + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Domain; + } + export interface Params$Resource$Projects$Locations$Backends$Domains$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error. + */ + etag?: string; + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/domains/{domainId\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Domains$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/domains/{domainId\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$Domains$List + extends StandardParameters { + /** + * Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. + */ + orderBy?: string; + /** + * Optional. The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. + */ + showDeleted?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Domains$Patch + extends StandardParameters { + /** + * Optional. If set to true, and the domain is not found, a new domain will be created. + */ + allowMissing?: boolean; + /** + * Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the Domain resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or modifying any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Domain; + } + + export class Resource$Projects$Locations$Backends$Rollouts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new rollout for a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Rollouts$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backends$Rollouts$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Rollouts$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Rollouts$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Rollouts$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/rollouts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about a rollout. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Rollouts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Rollouts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Rollouts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Rollouts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Rollouts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists rollouts for a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Rollouts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backends$Rollouts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backends$Rollouts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Rollouts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Rollouts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Rollouts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Rollouts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Rollouts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/rollouts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Rollouts$Create + extends StandardParameters { + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Desired ID of the rollout being created. + */ + rolloutId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Rollout; + } + export interface Params$Resource$Projects$Locations$Backends$Rollouts$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/rollouts/{rolloutId\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$Rollouts$List + extends StandardParameters { + /** + * Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. + */ + orderBy?: string; + /** + * Optional. The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. + */ + showDeleted?: boolean; + } + + export class Resource$Projects$Locations$Backends$Traffic { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets information about a backend's traffic. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Traffic$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Traffic$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Traffic$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Traffic$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Traffic$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Traffic$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Traffic$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Traffic$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a backend's traffic. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Traffic$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backends$Traffic$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backends$Traffic$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Traffic$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Traffic$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Traffic$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Traffic$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Traffic$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Traffic$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/traffic`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$Traffic$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the backend's traffic. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/traffic`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the traffic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + /** + * Optional. Indicates that the request should be validated, without persisting the request or updating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Traffic; + } + + 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://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } +} diff --git a/src/apis/firebaseapphosting/v1beta.ts b/src/apis/firebaseapphosting/v1beta.ts new file mode 100644 index 0000000000..bb3d09bf81 --- /dev/null +++ b/src/apis/firebaseapphosting/v1beta.ts @@ -0,0 +1,3873 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace firebaseapphosting_v1beta { + export interface Options extends GlobalOptions { + version: 'v1beta'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Firebase App Hosting API + * + * Firebase App Hosting streamlines the development and deployment of dynamic Next.js and Angular applications, offering built-in framework support, GitHub integration, and integration with other Firebase products. You can use this API to intervene in the Firebase App Hosting build process and add custom functionality not supported in our default Console & CLI flows, including triggering builds from external CI/CD workflows or deploying from pre-built container images. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const firebaseapphosting = google.firebaseapphosting('v1beta'); + * ``` + */ + export class Firebaseapphosting { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * The URI of an storage archive or a signed URL to use as the build source. + */ + export interface Schema$ArchiveSource { + /** + * Optional. The author contained in the metadata of a version control change. + */ + author?: Schema$SourceUserMetadata; + /** + * Optional. An optional message that describes the uploaded version of the source code. + */ + description?: string | null; + /** + * Signed URL to an archive in a storage bucket. + */ + externalSignedUri?: string | null; + /** + * Optional. Relative path in the archive. + */ + rootDirectory?: string | null; + /** + * URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy. + */ + userStorageUri?: string | null; + } + /** + * A backend is the primary resource of App Hosting. + */ + export interface Schema$Backend { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. + */ + annotations?: {[key: string]: string} | null; + /** + * Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend. + */ + appId?: string | null; + /** + * Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend. + */ + codebase?: Schema$Codebase; + /** + * Output only. Time at which the backend was created. + */ + createTime?: string | null; + /** + * Output only. Time at which the backend was deleted. + */ + deleteTime?: string | null; + /** + * Optional. Human-readable name. 63 character limit. + */ + displayName?: string | null; + /** + * Optional. The environment name of the backend, used to load environment variables from environment specific configuration. + */ + environment?: string | null; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. A list of the resources managed by this backend. + */ + managedResources?: Schema$ManagedResource[]; + /** + * Optional. Deprecated: Use `environment` instead. + */ + mode?: string | null; + /** + * Identifier. The resource name of the backend. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + name?: string | null; + /** + * Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. + */ + reconciling?: boolean | null; + /** + * Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. + */ + serviceAccount?: string | null; + /** + * Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS). + */ + servingLocality?: string | null; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the backend was last updated. + */ + updateTime?: string | null; + /** + * Output only. The primary URI to communicate with the backend. + */ + uri?: string | null; + } + /** + * A single build for a backend, at a specific point codebase reference tag and point in time. Encapsulates several resources, including an Artifact Registry container image, a Cloud Build invocation that built the image, and the Cloud Run revision that uses that image. + */ + export interface Schema$Build { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. + */ + buildLogsUri?: string | null; + /** + * Optional. Additional configuration of the service. + */ + config?: Schema$Config; + /** + * Output only. Time at which the build was created. + */ + createTime?: string | null; + /** + * Output only. Time at which the build was deleted. + */ + deleteTime?: string | null; + /** + * Optional. Human-readable name. 63 character limit. + */ + displayName?: string | null; + /** + * Output only. The environment name of the backend when this build was created. + */ + environment?: string | null; + /** + * Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated. Use `errors` instead. + */ + error?: Schema$Status; + /** + * Output only. A list of all errors that occurred during an App Hosting build. + */ + errors?: Schema$Error[]; + /** + * Output only. The source of the error for the build, if in a `FAILED` state. Deprecated. Use `errors` instead. + */ + errorSource?: string | null; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Output only. The Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) URI, used by the Cloud Run [`revision`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services.revisions) for this build. + */ + image?: string | null; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the build. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/builds/{buildId\}`. + */ + name?: string | null; + /** + * Output only. A field that, if true, indicates that the build has an ongoing LRO. + */ + reconciling?: boolean | null; + /** + * Required. Immutable. The source for the build. + */ + source?: Schema$BuildSource; + /** + * Output only. The state of the build. + */ + state?: string | null; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the build was last updated. + */ + updateTime?: string | null; + } + /** + * The source for the build. + */ + export interface Schema$BuildSource { + /** + * An archive source. + */ + archive?: Schema$ArchiveSource; + /** + * A codebase source. + */ + codebase?: Schema$CodebaseSource; + /** + * An Artifact Registry container image source. + */ + container?: Schema$ContainerSource; + } + /** + * The connection to an external source repository to watch for event-driven updates to the backend. + */ + export interface Schema$Codebase { + /** + * Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project\}/locations/{location\}/connections/{connection\}/gitRepositoryLinks/{repositoryLink\}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console. + */ + repository?: string | null; + /** + * Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. + */ + rootDirectory?: string | null; + } + /** + * A codebase source, representing the state of the codebase that the build will be created at. + */ + export interface Schema$CodebaseSource { + /** + * Output only. The author contained in the metadata of a version control change. + */ + author?: Schema$UserMetadata; + /** + * The branch in the codebase to build from, using the latest commit. + */ + branch?: string | null; + /** + * The commit in the codebase to build from. + */ + commit?: string | null; + /** + * Output only. The message of a codebase change. + */ + commitMessage?: string | null; + /** + * Output only. The time the change was made. + */ + commitTime?: string | null; + /** + * Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com. + */ + displayName?: string | null; + /** + * Output only. The full SHA-1 hash of a Git commit, if available. + */ + hash?: string | null; + /** + * Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository. + */ + uri?: string | null; + } + /** + * Additional configuration of the backend for this build. + */ + export interface Schema$Config { + /** + * Optional. Environment variables for this build. + */ + env?: Schema$EnvironmentVariable[]; + /** + * Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). + */ + runConfig?: Schema$RunConfig; + } + /** + * The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. + */ + export interface Schema$ContainerSource { + /** + * Required. A URI representing a container for the backend to use. + */ + image?: string | null; + } + /** + * Additional metadata for operations on custom domains. + */ + export interface Schema$CustomDomainOperationMetadata { + /** + * Output only. The custom domain's `CertState`, which must be `CERT_ACTIVE` for the create operations to complete. + */ + certState?: string | null; + /** + * Output only. The custom domain's `HostState`, which must be `HOST_ACTIVE` for Create operations of the domain name this `CustomDomain` refers toto complete. + */ + hostState?: string | null; + /** + * Output only. A list of issues that are currently preventing the operation from completing. These are generally DNS-related issues encountered when querying a domain's records or attempting to mint an SSL certificate. + */ + issues?: Schema$Status[]; + /** + * Output only. A list of steps that the user must complete to migrate their domain to App Hosting without downtime. + */ + liveMigrationSteps?: Schema$LiveMigrationStep[]; + /** + * Output only. The custom domain's `OwnershipState`, which must be `OWNERSHIP_ACTIVE` for the create operations to complete. + */ + ownershipState?: string | null; + /** + * Output only. A set of DNS record updates to perform, to allow App Hosting to serve secure content on the domain. + */ + quickSetupUpdates?: Schema$DnsUpdates[]; + } + /** + * The status of a custom domain's linkage to a backend. + */ + export interface Schema$CustomDomainStatus { + /** + * Output only. Tracks SSL certificate status for the domain. + */ + certState?: string | null; + /** + * Output only. Tracks whether a custom domain is detected as appropriately directing traffic to App Hosting. + */ + hostState?: string | null; + /** + * Output only. A list of issues with domain configuration. Allows users to self-correct problems with DNS records. + */ + issues?: Schema$Status[]; + /** + * Output only. Tracks whether the backend is permitted to serve content on the domain, based off the domain's DNS records. + */ + ownershipState?: string | null; + /** + * Output only. Lists the records that must added or removed to a custom domain's DNS in order to finish setup and start serving content. Field is present during onboarding. Also present after onboarding if one or more of the above states is not *_ACTIVE, indicating the domain's DNS records are in a bad state. + */ + requiredDnsUpdates?: Schema$DnsUpdates[]; + } + /** + * A representation of a DNS records for a domain. DNS records are resource records that define how systems and services should behave when handling requests for a domain. For example, when you add `A` records to your domain's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain (such as your App Hosting files). + */ + export interface Schema$DnsRecord { + /** + * Output only. The domain the record pertains to, e.g. `foo.bar.com.`. + */ + domainName?: string | null; + /** + * Output only. The data of the record. The meaning of the value depends on record type: - A and AAAA: IP addresses for the domain. - CNAME: Another domain to check for records. - TXT: Arbitrary text strings associated with the domain. App Hosting uses TXT records to determine which Firebase projects have permission to act on the domain's behalf. - CAA: The record's flags, tag, and value, e.g. `0 issue "pki.goog"`. + */ + rdata?: string | null; + /** + * Output only. An enum that indicates which state(s) this DNS record applies to. Populated for all records with an `ADD` or `REMOVE` required action. + */ + relevantState?: string[] | null; + /** + * Output only. An enum that indicates the a required action for this record. Populated when the record is part of a required change in a `DnsUpdates` `discovered` or `desired` record set. + */ + requiredAction?: string | null; + /** + * Output only. The record's type, which determines what data the record contains. + */ + type?: string | null; + } + /** + * A set of DNS records relevant to the setup and maintenance of a custom domain in App Hosting. + */ + export interface Schema$DnsRecordSet { + /** + * Output only. An error App Hosting services encountered when querying your domain's DNS records. Note: App Hosting ignores `NXDOMAIN` errors, as those generally just mean that a domain name hasn't been set up yet. + */ + checkError?: Schema$Status; + /** + * Output only. The domain name the record set pertains to. + */ + domainName?: string | null; + /** + * Output only. Records on the domain. + */ + records?: Schema$DnsRecord[]; + } + /** + * A set of DNS record updates that you should make to allow App Hosting to serve secure content in response to requests against your domain. These updates present the current state of your domain's and related subdomains' DNS records when App Hosting last queried them, and the desired set of records that App Hosting needs to see before your custom domain can be fully active. + */ + export interface Schema$DnsUpdates { + /** + * Output only. The last time App Hosting checked your custom domain's DNS records. + */ + checkTime?: string | null; + /** + * Output only. The set of DNS records App Hosting needs in order to be able to serve secure content on the domain. + */ + desired?: Schema$DnsRecordSet[]; + /** + * Output only. The set of DNS records App Hosting discovered when inspecting a domain. + */ + discovered?: Schema$DnsRecordSet[]; + /** + * Output only. The domain name the DNS updates pertain to. + */ + domainName?: string | null; + } + /** + * A domain name that is associated with a backend. + */ + export interface Schema$Domain { + /** + * Optional. Annotations as key value pairs. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. Time at which the domain was created. + */ + createTime?: string | null; + /** + * Output only. Represents the state and configuration of a `CUSTOM` type domain. It is only present on Domains of that type. + */ + customDomainStatus?: Schema$CustomDomainStatus; + /** + * Output only. Time at which the domain was deleted. + */ + deleteTime?: string | null; + /** + * Optional. Whether the domain is disabled. Defaults to false. + */ + disabled?: boolean | null; + /** + * Optional. Mutable human-readable name for the domain. 63 character limit. e.g. `prod domain`. + */ + displayName?: string | null; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Optional. Labels as key value pairs. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com` + */ + name?: string | null; + /** + * Output only. Time at which a soft-deleted domain will be purged, rendering in permanently deleted. + */ + purgeTime?: string | null; + /** + * Output only. A field that, if true, indicates that the build has an ongoing LRO. + */ + reconciling?: boolean | null; + /** + * Optional. The serving behavior of the domain. If specified, the domain will serve content other than its backend's live content. + */ + serve?: Schema$ServingBehavior; + /** + * Output only. The type of the domain. + */ + type?: string | null; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the domain was last updated. + */ + updateTime?: string | null; + } + /** + * Represents the metadata of a long-running operation on domains. + */ + export interface Schema$DomainOperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. Additional metadata for operations on custom domains. + */ + customDomainOperationMetadata?: Schema$CustomDomainOperationMetadata; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * 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 {} + /** + * Environment variables for this build. + */ + export interface Schema$EnvironmentVariable { + /** + * Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + */ + availability?: string[] | null; + /** + * A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + */ + secret?: string | null; + /** + * A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + */ + value?: string | null; + /** + * Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + */ + variable?: string | null; + } + /** + * The container for the rpc status and source for any errors found during the build process. + */ + export interface Schema$Error { + /** + * Output only. Resource link + */ + cloudResource?: string | null; + /** + * Output only. A status and (human readable) error message for the build, if in a `FAILED` state. + */ + error?: Schema$Status; + /** + * Output only. The source of the error for the build, if in a `FAILED` state. + */ + errorSource?: string | null; + } + /** + * Message for response to list backends + */ + export interface Schema$ListBackendsResponse { + /** + * The list of backends + */ + backends?: Schema$Backend[]; + /** + * A token identifying the next page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to list builds. + */ + export interface Schema$ListBuildsResponse { + /** + * The list of builds. + */ + builds?: Schema$Build[]; + /** + * A token identifying the next page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to list domains. + */ + export interface Schema$ListDomainsResponse { + /** + * Output only. The list of domains. + */ + domains?: Schema$Domain[]; + /** + * Output only. A token identifying the next page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Output only. Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * Message for response to list rollouts. + */ + export interface Schema$ListRolloutsResponse { + /** + * A token identifying the next page of results the server should return. + */ + nextPageToken?: string | null; + /** + * The list of rollouts. + */ + rollouts?: Schema$Rollout[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * A set of updates including ACME challenges and DNS records that allow App Hosting to create an SSL certificate and establish project ownership for your domain name before you direct traffic to App Hosting servers. Use these updates to facilitate zero downtime migrations to App Hosting from other services. After you've made the recommended updates, check your custom domain's `ownershipState` and `certState`. To avoid downtime, they should be `OWNERSHIP_ACTIVE` and `CERT_ACTIVE`, respectively, before you update your `A` and `AAAA` records. + */ + export interface Schema$LiveMigrationStep { + /** + * Output only. DNS updates to facilitate your domain's zero-downtime migration to App Hosting. + */ + dnsUpdates?: Schema$DnsUpdates[]; + /** + * Output only. Issues that prevent the current step from completing. + */ + issues?: Schema$Status[]; + /** + * Output only. One or more states from the `CustomDomainStatus` of the migrating domain that this step is attempting to make ACTIVE. For example, if the step is attempting to mint an SSL certificate, this field will include `CERT_STATE`. + */ + relevantDomainStates?: string[] | null; + /** + * Output only. The state of the live migration step, indicates whether you should work to complete the step now, in the future, or have already completed it. + */ + stepState?: string | null; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * An external resource managed by App Hosting on the project. + */ + export interface Schema$ManagedResource { + /** + * A Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service), managed by App Hosting. + */ + runService?: Schema$RunService; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`. + */ + name?: string | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of a long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * Specifies redirect behavior for a domain. + */ + export interface Schema$Redirect { + /** + * Optional. The status code to use in a redirect response. Must be a valid HTTP 3XX status code. Defaults to 302 if not present. + */ + status?: string | null; + /** + * Required. The URI of the redirect's intended destination. This URI will be prepended to the original request path. URI without a scheme are assumed to be HTTPS. + */ + uri?: string | null; + } + /** + * A single rollout of a build for a backend. + */ + export interface Schema$Rollout { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. + */ + annotations?: {[key: string]: string} | null; + /** + * Immutable. The name of a build that already exists. It doesn't have to be built; a rollout will wait for a build to be ready before updating traffic. + */ + build?: string | null; + /** + * Output only. Time at which the rollout was created. + */ + createTime?: string | null; + /** + * Output only. Time at which the rollout was deleted. + */ + deleteTime?: string | null; + /** + * Optional. Human-readable name. 63 character limit. + */ + displayName?: string | null; + /** + * Output only. A status and (human readable) error message for the rollout, if in a `FAILED` state. + */ + error?: Schema$Status; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the rollout. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/rollouts/{rolloutId\}`. + */ + name?: string | null; + /** + * Output only. A field that, if true, indicates that the Rollout currently has an LRO. + */ + reconciling?: boolean | null; + /** + * Output only. The state of the rollout. + */ + state?: string | null; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the rollout was last updated. + */ + updateTime?: string | null; + } + /** + * The policy for how automatic builds and rollouts are triggered and rolled out. + */ + export interface Schema$RolloutPolicy { + /** + * If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen. + */ + codebaseBranch?: string | null; + /** + * Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy. + */ + disabled?: boolean | null; + /** + * Output only. If `disabled` is set, the time at which the automatic rollouts were disabled. + */ + disabledTime?: string | null; + } + /** + * Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). + */ + export interface Schema$RunConfig { + /** + * Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000. + */ + concurrency?: number | null; + /** + * Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB + */ + cpu?: number | null; + /** + * Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits. + */ + maxInstances?: number | null; + /** + * Optional. Amount of memory allocated for each serving instance in MiB. By default, memory defaults to the Cloud Run's default where each instance is allocated 512 MiB of memory. Memory can be set to any integer value between 128 to 32768. Increasing memory limit may require increase in CPUs limits: - Over 4 GiB: at least 2 CPUs - Over 8 GiB: at least 4 CPUs - Over 16 GiB: at least 6 CPUs - Over 24 GiB: at least 8 CPUs + */ + memoryMib?: number | null; + /** + * Optional. Number of Cloud Run instances to maintain at minimum for each Cloud Run Service. By default, there are no minimum. Even if the service splits traffic across multiple revisions, the total number of instances for a service will be capped at this value. + */ + minInstances?: number | null; + } + /** + * A managed Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). + */ + export interface Schema$RunService { + /** + * Optional. The name of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service), in the format: `projects/{project\}/locations/{location\}/services/{serviceId\}` + */ + service?: string | null; + } + /** + * Indicates whether App Hosting will serve content on the domain. + */ + export interface Schema$ServingBehavior { + /** + * Optional. Redirect behavior for a domain, if provided. + */ + redirect?: Schema$Redirect; + } + /** + * Metadata for the user who started the build. + */ + export interface Schema$SourceUserMetadata { + /** + * Output only. The user-chosen displayname. May be empty. + */ + displayName?: string | null; + /** + * Output only. The account email linked to the EUC that created the build. May be a service account or other robot account. + */ + email?: string | null; + /** + * Output only. The URI of a profile photo associated with the user who created the build. + */ + imageUri?: string | null; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } + /** + * Controls traffic configuration for the backend. + */ + export interface Schema$Traffic { + /** + * Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. Time at which the backend was created. + */ + createTime?: string | null; + /** + * Output only. Current state of traffic allocation for the backend. When setting `target`, this field may differ for some time until the desired state is reached. + */ + current?: Schema$TrafficSet; + /** + * Output only. Server-computed checksum based on other values; may be sent on update or delete to ensure operation is done on expected resource. + */ + etag?: string | null; + /** + * Optional. Unstructured key value map that can be used to organize and categorize objects. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the backend's traffic. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/traffic`. + */ + name?: string | null; + /** + * Output only. A field that, if true, indicates that the system is working to make the backend's `current` match the requested `target` list. + */ + reconciling?: boolean | null; + /** + * A rollout policy specifies how new builds and automatic deployments are created. + */ + rolloutPolicy?: Schema$RolloutPolicy; + /** + * Set to manually control the desired traffic for the backend. This will cause `current` to eventually match this value. The percentages must add up to 100%. + */ + target?: Schema$TrafficSet; + /** + * Output only. System-assigned, unique identifier. + */ + uid?: string | null; + /** + * Output only. Time at which the backend was last updated. + */ + updateTime?: string | null; + } + /** + * A list of traffic splits that together represent where traffic is being routed. + */ + export interface Schema$TrafficSet { + /** + * Required. The list of traffic splits. + */ + splits?: Schema$TrafficSplit[]; + } + /** + * The traffic allocation for the backend. + */ + export interface Schema$TrafficSplit { + /** + * Required. The build that traffic is being routed to. + */ + build?: string | null; + /** + * Required. The percentage of traffic to send to the build. Currently must be 100% or 0%. + */ + percent?: number | null; + } + /** + * Version control metadata for a user associated with a resolved codebase. Currently assumes a Git user. + */ + export interface Schema$UserMetadata { + /** + * Output only. The 'name' field in a Git user's git.config. Required by Git. + */ + displayName?: string | null; + /** + * Output only. The 'email' field in a Git user's git.config, if available. + */ + email?: string | null; + /** + * Output only. The URI of an image file associated with the user's account in an external source control provider, if available. + */ + imageUri?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + backends: Resource$Projects$Locations$Backends; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.backends = new Resource$Projects$Locations$Backends(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + + /** + * Gets information about 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. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this 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. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Backends { + context: APIRequestContext; + builds: Resource$Projects$Locations$Backends$Builds; + domains: Resource$Projects$Locations$Backends$Domains; + rollouts: Resource$Projects$Locations$Backends$Rollouts; + traffic: Resource$Projects$Locations$Backends$Traffic; + constructor(context: APIRequestContext) { + this.context = context; + this.builds = new Resource$Projects$Locations$Backends$Builds( + this.context + ); + this.domains = new Resource$Projects$Locations$Backends$Domains( + this.context + ); + this.rollouts = new Resource$Projects$Locations$Backends$Rollouts( + this.context + ); + this.traffic = new Resource$Projects$Locations$Backends$Traffic( + this.context + ); + } + + /** + * Creates a new backend in a given 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. + */ + create( + params: Params$Resource$Projects$Locations$Backends$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backends$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backends$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/backends').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backends$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backends$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists backends in a given 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$Backends$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backends$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backends$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/backends').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the information for a single backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backends$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backends$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Create + extends StandardParameters { + /** + * Required. Id of the backend. Also used as the service ID for Cloud Run, and as part of the default domain name. + */ + backendId?: string; + /** + * Required. A parent name of the form `projects/{project\}/locations/{locationId\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Backend; + } + export interface Params$Resource$Projects$Locations$Backends$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error. + */ + etag?: string; + /** + * Optional. If set to true, any resources for this backend will also be deleted. Otherwise, any children resources will block deletion. + */ + force?: boolean; + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated, without persisting the request or updating any resources. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$List + extends StandardParameters { + /** + * Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. + */ + orderBy?: string; + /** + * Optional. The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + /** + * Required. A parent name of the form `projects/{project\}/locations/{locationId\}`. + */ + parent?: string; + /** + * Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. + */ + showDeleted?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Patch + extends StandardParameters { + /** + * Optional. If set to true, and the backend is not found, a new backend will be created. + */ + allowMissing?: boolean; + /** + * Identifier. The resource name of the backend. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the backend resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + /** + * Optional. Indicates that the request should be validated, without persisting the request or updating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Backend; + } + + export class Resource$Projects$Locations$Backends$Builds { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new build for a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Builds$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backends$Builds$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backends$Builds$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Builds$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Builds$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Builds$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Builds$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Builds$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/builds').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single build. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Builds$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backends$Builds$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backends$Builds$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Builds$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Builds$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Builds$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Builds$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Builds$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about a build. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Builds$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Builds$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Builds$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Builds$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Builds$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Builds$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Builds$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Builds$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists builds in a given project, location, and backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Builds$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backends$Builds$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backends$Builds$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Builds$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Builds$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Builds$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Builds$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Builds$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/builds').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Builds$Create + extends StandardParameters { + /** + * Required. Desired ID of the build being created. + */ + buildId?: string; + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Build; + } + export interface Params$Resource$Projects$Locations$Backends$Builds$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error. + */ + etag?: string; + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/builds/{buildId\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Builds$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/builds/{buildId\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$Builds$List + extends StandardParameters { + /** + * Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. + */ + orderBy?: string; + /** + * Optional. The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent backend in the form `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. + */ + showDeleted?: boolean; + } + + export class Resource$Projects$Locations$Backends$Domains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Links a new domain to a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backends$Domains$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backends$Domains$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Domains$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Domains$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Domains$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/domains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single domain. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backends$Domains$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backends$Domains$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Domains$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backends$Domains$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Domains$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about a domain. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Domains$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Domains$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Domains$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Domains$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Domains$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists domains of a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backends$Domains$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backends$Domains$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Domains$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Domains$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Domains$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/domains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the information for a single domain. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Domains$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backends$Domains$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backends$Domains$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Domains$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Domains$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Domains$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Domains$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Domains$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Domains$Create + extends StandardParameters { + /** + * Required. Id of the domain to create. Must be a valid domain name. + */ + domainId?: string; + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Domain; + } + export interface Params$Resource$Projects$Locations$Backends$Domains$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag is out of date, delete will be returned FAILED_PRECONDITION error. + */ + etag?: string; + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/domains/{domainId\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or deleting any resources. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Domains$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/domains/{domainId\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$Domains$List + extends StandardParameters { + /** + * Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. + */ + orderBy?: string; + /** + * Optional. The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. + */ + showDeleted?: boolean; + } + export interface Params$Resource$Projects$Locations$Backends$Domains$Patch + extends StandardParameters { + /** + * Optional. If set to true, and the domain is not found, a new domain will be created. + */ + allowMissing?: boolean; + /** + * Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/backends/b/domains/foo.com` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the Domain resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or modifying any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Domain; + } + + export class Resource$Projects$Locations$Backends$Rollouts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new rollout for a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Rollouts$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backends$Rollouts$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Rollouts$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Rollouts$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Rollouts$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/rollouts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about a rollout. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Rollouts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Rollouts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Rollouts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Rollouts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Rollouts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Rollouts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists rollouts for a backend. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Rollouts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backends$Rollouts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backends$Rollouts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Rollouts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backends$Rollouts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Rollouts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Rollouts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Rollouts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/rollouts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Rollouts$Create + extends StandardParameters { + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Desired ID of the rollout being created. + */ + rolloutId?: string; + /** + * Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Rollout; + } + export interface Params$Resource$Projects$Locations$Backends$Rollouts$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/rollouts/{rolloutId\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$Rollouts$List + extends StandardParameters { + /** + * Optional. A filter to narrow down results to a preferred subset. Learn more about filtering in Google's [AIP 160 standard](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. Hint for how to order the results. Supported fields are `name` and `createTime`. To specify descending order, append a `desc` suffix. + */ + orderBy?: string; + /** + * Optional. The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * Optional. A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent backend in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}`. + */ + parent?: string; + /** + * Optional. If true, the request returns soft-deleted resources that haven't been fully-deleted yet. + */ + showDeleted?: boolean; + } + + export class Resource$Projects$Locations$Backends$Traffic { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets information about a backend's traffic. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Traffic$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backends$Traffic$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backends$Traffic$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Traffic$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backends$Traffic$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Traffic$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Traffic$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backends$Traffic$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a backend's traffic. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Backends$Traffic$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backends$Traffic$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backends$Traffic$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Traffic$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backends$Traffic$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backends$Traffic$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backends$Traffic$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backends$Traffic$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backends$Traffic$Get + extends StandardParameters { + /** + * Required. Name of the resource in the format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/traffic`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backends$Traffic$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the backend's traffic. Format: `projects/{project\}/locations/{locationId\}/backends/{backendId\}/traffic`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the traffic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + /** + * Optional. Indicates that the request should be validated, without persisting the request or updating any resources. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Traffic; + } + + 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://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest 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://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists 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://firebaseapphosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + 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; + } +} diff --git a/src/apis/firebaseapphosting/webpack.config.js b/src/apis/firebaseapphosting/webpack.config.js new file mode 100644 index 0000000000..ffe7baa610 --- /dev/null +++ b/src/apis/firebaseapphosting/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Firebaseapphosting', + filename: 'firebaseapphosting.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index 8f6f5484bf..f7015f638a 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -685,6 +685,10 @@ export namespace firebaseml_v2beta { * Config for thinking features. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig { + /** + * Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. + */ + includeThoughts?: boolean | null; /** * Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true. */ diff --git a/src/apis/gkebackup/v1.ts b/src/apis/gkebackup/v1.ts index a104e9db53..96e5000188 100644 --- a/src/apis/gkebackup/v1.ts +++ b/src/apis/gkebackup/v1.ts @@ -349,10 +349,43 @@ export namespace gkebackup_v1 { */ selectedNamespaces?: Schema$Namespaces; } + /** + * BackupConfigDetails defines the configuration of Backups created via this BackupPlan. + */ + export interface Schema$BackupConfigDetails { + /** + * Output only. If True, include all namespaced resources + */ + allNamespaces?: boolean | null; + /** + * Output only. This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted. + */ + encryptionKey?: Schema$EncryptionKey; + /** + * Output only. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False + */ + includeSecrets?: boolean | null; + /** + * Output only. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False + */ + includeVolumeData?: boolean | null; + /** + * Output only. If set, include just the resources referenced by the listed ProtectedApplications. + */ + selectedApplications?: Schema$NamespacedNames; + /** + * Output only. If set, include just the resources in the listed namespaces. + */ + selectedNamespaces?: Schema$Namespaces; + } /** * Defines the configuration and scheduling for a "line" of Backups. */ export interface Schema$BackupPlan { + /** + * Output only. The fully qualified name of the BackupChannel to be used to create a backup. This field is set only if the cluster being backed up is in a different project. `projects/x/locations/x/backupChannels/x` + */ + backupChannel?: string | null; /** * Optional. Defines the configuration of Backups created via this BackupPlan. */ @@ -467,6 +500,10 @@ export namespace gkebackup_v1 { * Contains metadata about the backup plan/backup. */ export interface Schema$BackupPlanDetails { + /** + * Output only. Contains details about the BackupConfig of Backups created via this BackupPlan. + */ + backupConfigDetails?: Schema$BackupConfigDetails; /** * Output only. The fully qualified name of the last successful Backup created under this BackupPlan. `projects/x/locations/x/backupPlans/x/backups/x` */ @@ -483,6 +520,10 @@ export namespace gkebackup_v1 { * Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. */ protectedPodCount?: number | null; + /** + * Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan. + */ + retentionPolicyDetails?: Schema$RetentionPolicyDetails; /** * Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk. */ @@ -1290,6 +1331,10 @@ export namespace gkebackup_v1 { * Output only. The full name of the RestorePlan resource. Format: `projects/x/locations/x/restorePlans/x`. */ name?: string | null; + /** + * Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the `backup_plan` is in a different project than the RestorePlan. Format: `projects/x/locations/x/restoreChannels/x` + */ + restoreChannel?: string | null; /** * Required. Configuration of Restores created via this RestorePlan. */ @@ -1361,6 +1406,19 @@ export namespace gkebackup_v1 { */ locked?: boolean | null; } + /** + * RetentionPolicyDetails defines a Backup retention policy for a BackupPlan. + */ + export interface Schema$RetentionPolicyDetails { + /** + * Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value. Default: 0 (no delete blocking) + */ + backupDeleteLockDays?: number | null; + /** + * Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value \>= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Default: 0 (no automatic deletion) + */ + backupRetainDays?: number | null; + } /** * Defines RPO scheduling configuration for automatically creating Backups via this BackupPlan. */ diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index cdd49ca64e..5ea77517ad 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -2418,7 +2418,7 @@ export namespace healthcare_v1 { */ export interface Schema$SearchResourcesRequest { /** - * Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). */ resourceType?: string | null; } @@ -14020,7 +14020,7 @@ export namespace healthcare_v1 { } /** - * Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. + * Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14467,7 +14467,7 @@ export namespace healthcare_v1 { } /** - * Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource). + * Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14556,7 +14556,7 @@ export namespace healthcare_v1 { } /** - * Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#delete), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource). + * Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14642,7 +14642,7 @@ export namespace healthcare_v1 { } /** - * Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles). + * Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/fhir/STU3/http.html#transaction), [R4](https://hl7.org/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14728,7 +14728,7 @@ export namespace healthcare_v1 { } /** - * Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions). + * Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https://hl7.org/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14817,7 +14817,7 @@ export namespace healthcare_v1 { } /** - * Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource). + * Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14994,7 +14994,7 @@ export namespace healthcare_v1 { } /** - * Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources). + * Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-operation-everything.html)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15083,7 +15083,7 @@ export namespace healthcare_v1 { } /** - * Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cread), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource). + * Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15255,7 +15255,7 @@ export namespace healthcare_v1 { } /** - * Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate), [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), or [R4](https://hl7.org/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15344,7 +15344,7 @@ export namespace healthcare_v1 { } /** - * Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). + * Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15433,7 +15433,7 @@ export namespace healthcare_v1 { } /** - * Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). + * Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15521,7 +15521,7 @@ export namespace healthcare_v1 { } /** - * Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). + * Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15607,7 +15607,7 @@ export namespace healthcare_v1 { } /** - * Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version). + * Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15764,7 +15764,7 @@ export namespace healthcare_v1 { */ parent?: string; /** - * Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). */ type?: string; } @@ -15775,7 +15775,7 @@ export namespace healthcare_v1 { */ parent?: string; /** - * Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). */ type?: string; @@ -15791,7 +15791,7 @@ export namespace healthcare_v1 { */ parent?: string; /** - * Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -15814,7 +15814,7 @@ export namespace healthcare_v1 { */ parent?: string; /** - * Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -15948,7 +15948,7 @@ export namespace healthcare_v1 { */ profile?: string; /** - * Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), or [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -15976,7 +15976,7 @@ export namespace healthcare_v1 { */ parent?: string; /** - * Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). */ resourceType?: string; diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 12284f363f..3b94fcc95e 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -3081,7 +3081,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$SearchResourcesRequest { /** - * Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). */ resourceType?: string | null; } @@ -16773,7 +16773,7 @@ export namespace healthcare_v1beta1 { } /** - * Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. + * Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17041,7 +17041,7 @@ export namespace healthcare_v1beta1 { } /** - * Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource). + * Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17130,7 +17130,7 @@ export namespace healthcare_v1beta1 { } /** - * If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource). + * If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17219,7 +17219,7 @@ export namespace healthcare_v1beta1 { } /** - * If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource). + * If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](https://hl7.org/fhir/STU3/http.html#cond-update), [R4](https://hl7.org/fhir/R4/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17398,7 +17398,7 @@ export namespace healthcare_v1beta1 { } /** - * Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource). + * Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/fhir/STU3/http.html#create), [R4](https://hl7.org/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17487,7 +17487,7 @@ export namespace healthcare_v1beta1 { } /** - * Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#delete), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource). + * Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/fhir/STU3/http.html#delete), [R4](https://hl7.org/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17573,7 +17573,7 @@ export namespace healthcare_v1beta1 { } /** - * Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/encounter-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/implement/standards/fhir/R4/encounter-operation-everything.html). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" extension. + * Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](https://hl7.org/fhir/DSTU2/encounter-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/fhir/R4/encounter-operation-everything.html). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" extension. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17662,7 +17662,7 @@ export namespace healthcare_v1beta1 { } /** - * Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch`, `transaction` and `history`, processing `batch` and `transaction` bundles according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a `transaction` or `history` bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. `history` bundles also check the `import` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles). + * Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/fhir/STU3/http.html#transaction), [R4](https://hl7.org/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch`, `transaction` and `history`, processing `batch` and `transaction` bundles according to the batch processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a `transaction` or `history` bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. `history` bundles also check the `import` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17751,7 +17751,7 @@ export namespace healthcare_v1beta1 { } /** - * Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions). + * Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https://hl7.org/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17840,7 +17840,7 @@ export namespace healthcare_v1beta1 { } /** - * Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/fhir/R4/observation-operation-lastn.html)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17928,7 +17928,7 @@ export namespace healthcare_v1beta1 { } /** - * Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource). + * Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18104,7 +18104,7 @@ export namespace healthcare_v1beta1 { } /** - * Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources). + * Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/fhir/DSTU2/patient-operations.html#everything), [STU3](https://hl7.org/fhir/STU3/patient-operations.html#everything), [R4](https://hl7.org/fhir/R4/patient-operation-everything.html)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18193,7 +18193,7 @@ export namespace healthcare_v1beta1 { } /** - * Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#read), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#cread), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource). + * Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18459,7 +18459,7 @@ export namespace healthcare_v1beta1 { } /** - * Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](https://hl7.org/fhir/DSTU2/resource-operations.html#validate), [STU3](https://hl7.org/fhir/STU3/resource-operations.html#validate), or [R4](https://hl7.org/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18547,7 +18547,7 @@ export namespace healthcare_v1beta1 { } /** - * Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). + * Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18636,7 +18636,7 @@ export namespace healthcare_v1beta1 { } /** - * Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). + * Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18724,7 +18724,7 @@ export namespace healthcare_v1beta1 { } /** - * Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). + * Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18810,7 +18810,7 @@ export namespace healthcare_v1beta1 { } /** - * Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#vread), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version). + * Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19017,7 +19017,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). */ type?: string; } @@ -19028,7 +19028,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). */ type?: string; @@ -19044,7 +19044,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -19067,7 +19067,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -19258,7 +19258,7 @@ export namespace healthcare_v1beta1 { */ profile?: string; /** - * Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. + * Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), or [R4](https://hl7.org/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -19286,7 +19286,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + * Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)). */ resourceType?: string; diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 410df1565e..4179876f41 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -415,7 +415,7 @@ export namespace iam_v1 { */ export interface Schema$GoogleIamAdminV1WorkforcePoolProviderExtraAttributesOAuth2ClientQueryParameters { /** - * Optional. The filter used to request specific records from IdP. In case of attributes type as AZURE_AD_GROUPS_MAIL, it represents the filter used to request specific groups for users from IdP. By default, all of the groups associated with the user are fetched. The groups should be mail enabled and security enabled. See https://learn.microsoft.com/en-us/graph/search-query-parameter for more details. + * Optional. The filter used to request specific records from the IdP. By default, all of the groups that are associated with a user are fetched. For Microsoft Entra ID, you can add `$search` query parameters using [Keyword Query Language] (https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). To learn more about `$search` querying in Microsoft Entra ID, see [Use the `$search` query parameter] (https://learn.microsoft.com/en-us/graph/search-query-parameter). Additionally, Workforce Identity Federation automatically adds the following [`$filter` query parameters] (https://learn.microsoft.com/en-us/graph/filter-query-parameter), based on the value of `attributes_type`. Values passed to `filter` are converted to `$search` query parameters. Additional `$filter` query parameters cannot be added using this field. * `AZURE_AD_GROUPS_MAIL`: `mailEnabled` and `securityEnabled` filters are applied. * `AZURE_AD_GROUPS_ID`: `securityEnabled` filter is applied. */ filter?: string | null; } @@ -497,19 +497,19 @@ export namespace iam_v1 { */ export interface Schema$InlineCertificateIssuanceConfig { /** - * Optional. A required mapping of a cloud region to the CA pool resource located in that region used for certificate issuance, adhering to these constraints: * Key format: A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * Value format: A valid CA pool resource path format like: "projects/{project\}/locations/{location\}/caPools/{ca_pool\}" * Region Matching: Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key). + * Optional. A required mapping of a Google Cloud region to the CA pool resource located in that region. The CA pool is used for certificate issuance, adhering to the following constraints: * Key format: A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * Value format: A valid CA pool resource path format like: "projects/{project\}/locations/{location\}/caPools/{ca_pool\}" * Region Matching: Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key). */ caPools?: {[key: string]: string} | null; /** - * Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If unspecified, this will default to ECDSA_P256. + * Optional. Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If not specified, this will default to ECDSA_P256. */ keyAlgorithm?: string | null; /** - * Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 10 hours - 30 days. If unspecified, this will be defaulted to 24 hours. + * Optional. Lifetime of the workload certificates issued by the CA pool. Must be between 10 hours and 30 days. If not specified, this will be defaulted to 24 hours. */ lifetime?: string | null; /** - * Optional. Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between 10 - 80. If unspecified, this will be defaulted to 50. + * Optional. Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between 10 and 80. If not specified, this will be defaulted to 50. */ rotationWindowPercentage?: number | null; } @@ -518,7 +518,7 @@ export namespace iam_v1 { */ export interface Schema$InlineTrustConfig { /** - * Optional. Maps specific trust domains (e.g., "example.com") to their corresponding TrustStore objects, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the Trust Bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools. + * Optional. Maps specific trust domains (e.g., "example.com") to their corresponding TrustStore, which contain the trusted root certificates for that domain. There can be a maximum of 10 trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this WorkloadIdentityPool's trust domain contains any trust anchors in the additional_trust_bundles map, those trust anchors will be *appended to* the trust bundle automatically derived from your InlineCertificateIssuanceConfig's ca_pools. */ additionalTrustBundles?: {[key: string]: Schema$TrustStore} | null; } @@ -860,7 +860,7 @@ export namespace iam_v1 { */ allowedAudiences?: string[] | null; /** - * Required. The OIDC issuer URL. Must be an HTTPS endpoint. Used per OpenID Connect Discovery 1.0 spec to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'. + * Required. The OIDC issuer URL. Must be an HTTPS endpoint. Per OpenID Connect Discovery 1.0 spec, the OIDC issuer URL is used to locate the provider's public keys (via `jwks_uri`) for verifying tokens like the OIDC ID token. These public key types must be 'EC' or 'RSA'. */ issuerUri?: string | null; /** @@ -1042,7 +1042,7 @@ export namespace iam_v1 { */ export interface Schema$QueryGrantableRolesRequest { /** - * Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. + * Required. Required. The full resource name to query from the list of grantable roles. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. */ fullResourceName?: string | null; /** @@ -1376,15 +1376,15 @@ export namespace iam_v1 { pemCertificate?: string | null; } /** - * Trust store that contains trust anchors and optional intermediate CAs used in PKI to build trust chain and verify client's identity. + * Trust store that contains trust anchors and optional intermediate CAs used in PKI to build trust chain and verify a client's identity. */ export interface Schema$TrustStore { /** - * Optional. Set of intermediate CA certificates used for building the trust chain to trust anchor. IMPORTANT: * Intermediate CAs are only supported when configuring x509 federation. + * Optional. Set of intermediate CA certificates used for building the trust chain to the trust anchor. Important: Intermediate CAs are only supported for X.509 federation. */ intermediateCas?: Schema$IntermediateCA[]; /** - * Required. List of Trust Anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be chained up to one of the trust anchors here. + * Required. List of trust anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be in the trust chain of one of the trust anchors here. */ trustAnchors?: Schema$TrustAnchor[]; } @@ -1513,6 +1513,10 @@ export namespace iam_v1 { * Optional. A user-specified description of the provider. Cannot exceed 256 characters. */ description?: string | null; + /** + * Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false. + */ + detailedAuditLogging?: boolean | null; /** * Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. */ @@ -1753,7 +1757,7 @@ export namespace iam_v1 { */ export interface Schema$X509 { /** - * Required. A Trust store, use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the x509 guidelines to define those PEM encoded certs. Only 1 trust store is currently supported. + * Required. A TrustStore. Use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the X.509 guidelines to define those PEM encoded certs. Only one trust store is currently supported. */ trustStore?: Schema$TrustStore; } @@ -6852,7 +6856,7 @@ export namespace iam_v1 { } /** - * Gets IAM policies for one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity + * Gets the IAM policy of a WorkloadIdentityPool. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7125,7 +7129,7 @@ export namespace iam_v1 { } /** - * Sets IAM policies on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity + * Sets the IAM policies on a WorkloadIdentityPool * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7214,7 +7218,7 @@ export namespace iam_v1 { } /** - * Returns the caller's permissions on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity + * Returns the caller's permissions on a WorkloadIdentityPool * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8527,7 +8531,7 @@ export namespace iam_v1 { } /** - * Lists all non-deleted WorkloadIdentityPoolManagedIdentitys in a namespace. If `show_deleted` is set to `true`, then deleted managed identites are also listed. + * Lists all non-deleted WorkloadIdentityPoolManagedIdentitys in a namespace. If `show_deleted` is set to `true`, then deleted managed identities are also listed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/iam/v2.ts b/src/apis/iam/v2.ts index 2b64209d9d..88718a879c 100644 --- a/src/apis/iam/v2.ts +++ b/src/apis/iam/v2.ts @@ -248,7 +248,7 @@ export namespace iam_v2 { */ deniedPermissions?: string[] | null; /** - * The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id\}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id\}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id\}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id\}?uid={uid\}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id\}?uid={uid\}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}?uid={uid\}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + * The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id\}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id\}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id\}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id\}?uid={uid\}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id\}?uid={uid\}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}?uid={uid\}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. */ deniedPrincipals?: string[] | null; /** diff --git a/src/apis/iam/v2beta.ts b/src/apis/iam/v2beta.ts index 0331b94053..60e857422d 100644 --- a/src/apis/iam/v2beta.ts +++ b/src/apis/iam/v2beta.ts @@ -248,7 +248,7 @@ export namespace iam_v2beta { */ deniedPermissions?: string[] | null; /** - * The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id\}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id\}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id\}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id\}?uid={uid\}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id\}?uid={uid\}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}?uid={uid\}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + * The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id\}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id\}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id\}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number\}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id\}?uid={uid\}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id\}?uid={uid\}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id\}?uid={uid\}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. */ deniedPrincipals?: string[] | null; /** diff --git a/src/apis/index.ts b/src/apis/index.ts index bdb945b49c..3c94d8acae 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -96,6 +96,7 @@ import { VERSIONS as apigeeregistryVersions, apigeeregistry, } from './apigeeregistry'; +import {VERSIONS as apihubVersions, apihub} from './apihub'; import {VERSIONS as apikeysVersions, apikeys} from './apikeys'; import {VERSIONS as apimVersions, apim} from './apim'; import {VERSIONS as appengineVersions, appengine} from './appengine'; @@ -334,6 +335,10 @@ import { VERSIONS as firebaseappdistributionVersions, firebaseappdistribution, } from './firebaseappdistribution'; +import { + VERSIONS as firebaseapphostingVersions, + firebaseapphosting, +} from './firebaseapphosting'; import { VERSIONS as firebasedatabaseVersions, firebasedatabase, @@ -775,6 +780,7 @@ export const APIS: APIList = { androidpublisher: androidpublisherVersions, apigateway: apigatewayVersions, apigeeregistry: apigeeregistryVersions, + apihub: apihubVersions, apikeys: apikeysVersions, apim: apimVersions, appengine: appengineVersions, @@ -884,6 +890,7 @@ export const APIS: APIList = { firebase: firebaseVersions, firebaseappcheck: firebaseappcheckVersions, firebaseappdistribution: firebaseappdistributionVersions, + firebaseapphosting: firebaseapphostingVersions, firebasedatabase: firebasedatabaseVersions, firebasedataconnect: firebasedataconnectVersions, firebasedynamiclinks: firebasedynamiclinksVersions, @@ -1087,6 +1094,7 @@ export class GeneratedAPIs { androidpublisher = androidpublisher; apigateway = apigateway; apigeeregistry = apigeeregistry; + apihub = apihub; apikeys = apikeys; apim = apim; appengine = appengine; @@ -1196,6 +1204,7 @@ export class GeneratedAPIs { firebase = firebase; firebaseappcheck = firebaseappcheck; firebaseappdistribution = firebaseappdistribution; + firebaseapphosting = firebaseapphosting; firebasedatabase = firebasedatabase; firebasedataconnect = firebasedataconnect; firebasedynamiclinks = firebasedynamiclinks; diff --git a/src/apis/managedkafka/v1.ts b/src/apis/managedkafka/v1.ts index 04a1f25a9c..cb8f8fb2a0 100644 --- a/src/apis/managedkafka/v1.ts +++ b/src/apis/managedkafka/v1.ts @@ -213,6 +213,40 @@ export namespace managedkafka_v1 { */ vcpuCount?: string | null; } + /** + * Request for CheckCompatibility. + */ + export interface Schema$CheckCompatibilityRequest { + /** + * Optional. The schema references used by the schema. + */ + references?: Schema$SchemaReference[]; + /** + * Required. The schema payload + */ + schema?: string | null; + /** + * Optional. The schema type of the schema. + */ + schemaType?: string | null; + /** + * Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false. + */ + verbose?: boolean | null; + } + /** + * Response for CheckCompatibility. + */ + export interface Schema$CheckCompatibilityResponse { + /** + * The compatibility check result. If true, the schema is compatible with the resource. + */ + is_compatible?: boolean | null; + /** + * Failure reasons if verbose = true. + */ + messages?: string[] | null; + } /** * An Apache Kafka cluster deployed in a location. */ @@ -394,6 +428,70 @@ export namespace managedkafka_v1 { */ partitions?: {[key: string]: Schema$ConsumerPartitionMetadata} | null; } + /** + * Context represents an independent schema grouping in a schema registry instance. + */ + export interface Schema$Context { + /** + * Identifier. The name of the context. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}` The context name {context\} can contain the following: * Up to 255 characters. * Allowed characters: letters (uppercase or lowercase), numbers, and the following special characters: `.`, `-`, `_`, `+`, `%`, and `~`. + */ + name?: string | null; + /** + * Optional. The subjects of the context. + */ + subjects?: string[] | null; + } + /** + * Request to create a schema registry instance. + */ + export interface Schema$CreateSchemaRegistryRequest { + /** + * Required. The schema registry instance to create. The name field is ignored. + */ + schemaRegistry?: Schema$SchemaRegistry; + /** + * Required. The schema registry instance ID to use for this schema registry. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (-). The maximum length is 63 characters. The ID must not start with a number. + */ + schemaRegistryId?: string | null; + } + /** + * Request for CreateVersion. + */ + export interface Schema$CreateVersionRequest { + /** + * Optional. The schema ID of the schema. If not specified, the schema ID will be generated by the server. If the schema ID is specified, it must not be used by an existing schema that is different from the schema to be created. + */ + id?: number | null; + /** + * Optional. If true, the schema will be normalized before being stored. The default is false. + */ + normalize?: boolean | null; + /** + * Optional. The schema references used by the schema. + */ + references?: Schema$SchemaReference[]; + /** + * Required. The schema payload + */ + schema?: string | null; + /** + * Optional. The type of the schema. It is optional. If not specified, the schema type will be AVRO. + */ + schemaType?: string | null; + /** + * Optional. The version to create. It is optional. If not specified, the version will be created with the max version ID of the subject increased by 1. If the version ID is specified, it will be used as the new version ID and must not be used by an existing version of the subject. + */ + version?: number | null; + } + /** + * Response for CreateVersion. + */ + export interface Schema$CreateVersionResponse { + /** + * The unique identifier of the schema created. + */ + id?: number | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -411,6 +509,23 @@ export namespace managedkafka_v1 { */ kmsKey?: string | null; } + /** + * Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; \} service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); \} Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); \} Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. + */ + export interface Schema$HttpBody { + /** + * The HTTP Content-Type header value specifying the content type of the body. + */ + contentType?: string | null; + /** + * The HTTP request/response body as raw binary. + */ + data?: string | null; + /** + * Application specific response metadata. Must be set in the first response for streaming APIs. + */ + extensions?: Array<{[key: string]: any}> | null; + } /** * Response for ListAcls. */ @@ -510,6 +625,15 @@ export namespace managedkafka_v1 { */ operations?: Schema$Operation[]; } + /** + * Request for ListSchemaRegistries. + */ + export interface Schema$ListSchemaRegistriesResponse { + /** + * The schema registry instances. + */ + schemaRegistries?: Schema$SchemaRegistry[]; + } /** * Response for ListTopics. */ @@ -548,6 +672,31 @@ export namespace managedkafka_v1 { */ name?: string | null; } + /** + * Request for LookupVersion. + */ + export interface Schema$LookupVersionRequest { + /** + * Optional. If true, soft-deleted versions will be included in lookup, no matter if the subject is active or soft-deleted. If false, soft-deleted versions will be excluded. The default is false. + */ + deleted?: boolean | null; + /** + * Optional. If true, the schema will be normalized before being looked up. The default is false. + */ + normalize?: boolean | null; + /** + * Optional. The schema references used by the schema. + */ + references?: Schema$SchemaReference[]; + /** + * Required. The schema payload + */ + schema?: string | null; + /** + * Optional. The schema type of the schema. + */ + schemaType?: string | null; + } /** * The configuration of a Virtual Private Cloud (VPC) network that can access the Kafka cluster. */ @@ -661,6 +810,108 @@ export namespace managedkafka_v1 { * Response for ResumeConnector. */ export interface Schema$ResumeConnectorResponse {} + /** + * Schema for a Kafka message. + */ + export interface Schema$Schema { + /** + * Optional. The schema references used by the schema. + */ + references?: Schema$SchemaReference[]; + /** + * The schema payload. + */ + schema?: string | null; + /** + * Optional. The schema type of the schema. + */ + schemaType?: string | null; + } + /** + * SchemaConfig represents configuration for a schema registry or a specific subject. + */ + export interface Schema$SchemaConfig { + /** + * Optional. The subject to which this subject is an alias of. Only applicable for subject config. + */ + alias?: string | null; + /** + * Required. The compatibility type of the schema. The default value is BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults to the global value. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value. + */ + compatibility?: string | null; + /** + * Optional. If true, the schema will be normalized before being stored or looked up. The default is false. If unset in a SchemaSubject-level SchemaConfig, the global value will be used. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value. + */ + normalize?: boolean | null; + } + /** + * SchemaMode represents the mode of a schema registry or a specific subject. Four modes are supported: * NONE: This is the default mode for a subject and essentially means that the subject does not have any mode set. This means the subject will follow the schema registry's mode. * READONLY: The schema registry is in read-only mode. * READWRITE: The schema registry is in read-write mode, which allows limited write operations on the schema. * IMPORT: The schema registry is in import mode, which allows more editing operations on the schema for data importing purposes. + */ + export interface Schema$SchemaMode { + /** + * Required. The mode type of a schema registry (READWRITE by default) or of a subject (NONE by default, which means use the global schema registry setting). + */ + mode?: string | null; + } + /** + * SchemaReference is a reference to a schema. + */ + export interface Schema$SchemaReference { + /** + * Required. The name of the reference. + */ + name?: string | null; + /** + * Required. The subject of the reference. + */ + subject?: string | null; + /** + * Required. The version of the reference. + */ + version?: number | null; + } + /** + * SchemaRegistry is a schema registry instance. + */ + export interface Schema$SchemaRegistry { + /** + * Output only. The contexts of the schema registry instance. + */ + contexts?: string[] | null; + /** + * Identifier. The name of the schema registry instance. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}` The instance name {schema_registry\} can contain the following: * Up to 255 characters. * Letters (uppercase or lowercase), numbers, and underscores. + */ + name?: string | null; + } + /** + * Version of a schema. + */ + export interface Schema$SchemaVersion { + /** + * Required. The schema ID. + */ + id?: number | null; + /** + * Optional. The schema references used by the schema. + */ + references?: Schema$SchemaReference[]; + /** + * Required. The schema payload. + */ + schema?: string | null; + /** + * Optional. The schema type of the schema. + */ + schemaType?: string | null; + /** + * Required. The subject of the version. + */ + subject?: string | null; + /** + * Required. The version ID + */ + version?: number | 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). */ @@ -720,6 +971,28 @@ export namespace managedkafka_v1 { */ replicationFactor?: number | null; } + /** + * Request for updating schema config. On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig. + */ + export interface Schema$UpdateSchemaConfigRequest { + /** + * Required. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig. + */ + compatibility?: string | null; + /** + * Optional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig. + */ + normalize?: boolean | null; + } + /** + * Request for updating schema registry or subject mode. + */ + export interface Schema$UpdateSchemaModeRequest { + /** + * Required. The mode type. + */ + mode?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -735,6 +1008,7 @@ export namespace managedkafka_v1 { clusters: Resource$Projects$Locations$Clusters; connectClusters: Resource$Projects$Locations$Connectclusters; operations: Resource$Projects$Locations$Operations; + schemaRegistries: Resource$Projects$Locations$Schemaregistries; constructor(context: APIRequestContext) { this.context = context; this.clusters = new Resource$Projects$Locations$Clusters(this.context); @@ -744,6 +1018,9 @@ export namespace managedkafka_v1 { this.operations = new Resource$Projects$Locations$Operations( this.context ); + this.schemaRegistries = new Resource$Projects$Locations$Schemaregistries( + this.context + ); } /** @@ -4973,4 +5250,4807 @@ export namespace managedkafka_v1 { */ pageToken?: string; } + + export class Resource$Projects$Locations$Schemaregistries { + context: APIRequestContext; + compatibility: Resource$Projects$Locations$Schemaregistries$Compatibility; + config: Resource$Projects$Locations$Schemaregistries$Config; + contexts: Resource$Projects$Locations$Schemaregistries$Contexts; + mode: Resource$Projects$Locations$Schemaregistries$Mode; + schemas: Resource$Projects$Locations$Schemaregistries$Schemas; + subjects: Resource$Projects$Locations$Schemaregistries$Subjects; + constructor(context: APIRequestContext) { + this.context = context; + this.compatibility = + new Resource$Projects$Locations$Schemaregistries$Compatibility( + this.context + ); + this.config = new Resource$Projects$Locations$Schemaregistries$Config( + this.context + ); + this.contexts = new Resource$Projects$Locations$Schemaregistries$Contexts( + this.context + ); + this.mode = new Resource$Projects$Locations$Schemaregistries$Mode( + this.context + ); + this.schemas = new Resource$Projects$Locations$Schemaregistries$Schemas( + this.context + ); + this.subjects = new Resource$Projects$Locations$Schemaregistries$Subjects( + this.context + ); + } + + /** + * Create a schema registry 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. + */ + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Schemaregistries$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/schemaRegistries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete a schema registry 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. + */ + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Schemaregistries$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get the schema registry 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. + */ + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Schemaregistries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List schema registries. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Schemaregistries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/schemaRegistries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Create + extends StandardParameters { + /** + * Required. The parent whose schema registry instance is to be created. Structured like: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateSchemaRegistryRequest; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Delete + extends StandardParameters { + /** + * Required. The name of the schema registry instance to delete. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Get + extends StandardParameters { + /** + * Required. The name of the schema registry instance to return. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$List + extends StandardParameters { + /** + * Required. The parent whose schema registry instances are to be listed. Structured like: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Compatibility { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Check compatibility of a schema with all versions or a specific version of a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + checkCompatibility( + params: Params$Resource$Projects$Locations$Schemaregistries$Compatibility$Checkcompatibility, + options: StreamMethodOptions + ): GaxiosPromise; + checkCompatibility( + params?: Params$Resource$Projects$Locations$Schemaregistries$Compatibility$Checkcompatibility, + options?: MethodOptions + ): GaxiosPromise; + checkCompatibility( + params: Params$Resource$Projects$Locations$Schemaregistries$Compatibility$Checkcompatibility, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkCompatibility( + params: Params$Resource$Projects$Locations$Schemaregistries$Compatibility$Checkcompatibility, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkCompatibility( + params: Params$Resource$Projects$Locations$Schemaregistries$Compatibility$Checkcompatibility, + callback: BodyResponseCallback + ): void; + checkCompatibility( + callback: BodyResponseCallback + ): void; + checkCompatibility( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Compatibility$Checkcompatibility + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Compatibility$Checkcompatibility; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Compatibility$Checkcompatibility; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Compatibility$Checkcompatibility + extends StandardParameters { + /** + * Required. The name of the resource to check compatibility for. The format is either of following: * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/compatibility/subjects/x/versions: Check compatibility with one or more versions of the specified subject. * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/compatibility/subjects/{subject\}/versions/{version\}: Check compatibility with a specific version of the subject. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CheckCompatibilityRequest; + } + + export class Resource$Projects$Locations$Schemaregistries$Config { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Delete schema config for a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Config$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Schemaregistries$Config$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Config$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Config$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Config$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get schema config at global level or for a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Config$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Config$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Config$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Config$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Config$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Projects$Locations$Schemaregistries$Config$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Config$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Config$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Config$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Config$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Config$Delete + extends StandardParameters { + /** + * Required. The resource name of subject to delete the config for. The format is * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config/{subject\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Config$Get + extends StandardParameters { + /** + * Optional. If true, the config will fall back to the config at the global level if no subject level config is found. + */ + defaultToGlobal?: boolean; + /** + * Required. The resource name to get the config for. It can be either of following: * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config: Get config at global level. * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config/{subject\}: Get config for a specific subject. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Config$Update + extends StandardParameters { + /** + * Required. The resource name to update the config for. It can be either of following: * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config: Update config at global level. * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config/{subject\}: Update config for a specific subject. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateSchemaConfigRequest; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts { + context: APIRequestContext; + compatibility: Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility; + config: Resource$Projects$Locations$Schemaregistries$Contexts$Config; + mode: Resource$Projects$Locations$Schemaregistries$Contexts$Mode; + schemas: Resource$Projects$Locations$Schemaregistries$Contexts$Schemas; + subjects: Resource$Projects$Locations$Schemaregistries$Contexts$Subjects; + constructor(context: APIRequestContext) { + this.context = context; + this.compatibility = + new Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility( + this.context + ); + this.config = + new Resource$Projects$Locations$Schemaregistries$Contexts$Config( + this.context + ); + this.mode = + new Resource$Projects$Locations$Schemaregistries$Contexts$Mode( + this.context + ); + this.schemas = + new Resource$Projects$Locations$Schemaregistries$Contexts$Schemas( + this.context + ); + this.subjects = + new Resource$Projects$Locations$Schemaregistries$Contexts$Subjects( + this.context + ); + } + + /** + * Get the context. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List contexts for a schema registry. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/contexts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Get + extends StandardParameters { + /** + * Required. The name of the context to return. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$List + extends StandardParameters { + /** + * Required. The parent of the contexts. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Check compatibility of a schema with all versions or a specific version of a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + checkCompatibility( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility$Checkcompatibility, + options: StreamMethodOptions + ): GaxiosPromise; + checkCompatibility( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility$Checkcompatibility, + options?: MethodOptions + ): GaxiosPromise; + checkCompatibility( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility$Checkcompatibility, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkCompatibility( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility$Checkcompatibility, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkCompatibility( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility$Checkcompatibility, + callback: BodyResponseCallback + ): void; + checkCompatibility( + callback: BodyResponseCallback + ): void; + checkCompatibility( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility$Checkcompatibility + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility$Checkcompatibility; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility$Checkcompatibility; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Compatibility$Checkcompatibility + extends StandardParameters { + /** + * Required. The name of the resource to check compatibility for. The format is either of following: * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/compatibility/subjects/x/versions: Check compatibility with one or more versions of the specified subject. * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/compatibility/subjects/{subject\}/versions/{version\}: Check compatibility with a specific version of the subject. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CheckCompatibilityRequest; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Config { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Delete schema config for a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Config$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get schema config at global level or for a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Config$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Delete + extends StandardParameters { + /** + * Required. The resource name of subject to delete the config for. The format is * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config/{subject\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Get + extends StandardParameters { + /** + * Optional. If true, the config will fall back to the config at the global level if no subject level config is found. + */ + defaultToGlobal?: boolean; + /** + * Required. The resource name to get the config for. It can be either of following: * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config: Get config at global level. * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config/{subject\}: Get config for a specific subject. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Config$Update + extends StandardParameters { + /** + * Required. The resource name to update the config for. It can be either of following: * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config: Update config at global level. * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/config/{subject\}: Update config for a specific subject. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateSchemaConfigRequest; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Mode { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get mode at global level or for a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Mode$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Update mode at global level or for a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Get + extends StandardParameters { + /** + * Required. The resource name of the mode. The format is * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/mode/{subject\}: mode for a schema registry, or * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/mode/{subject\}: mode for a specific subject in a specific context + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Mode$Update + extends StandardParameters { + /** + * Required. The resource name of the mode. The format is * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/mode/{subject\}: mode for a schema registry, or * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/mode/{subject\}: mode for a specific subject in a specific context + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateSchemaModeRequest; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Schemas { + context: APIRequestContext; + subjects: Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects; + types: Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types; + versions: Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions; + constructor(context: APIRequestContext) { + this.context = context; + this.subjects = + new Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects( + this.context + ); + this.types = + new Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types( + this.context + ); + this.versions = + new Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions( + this.context + ); + } + + /** + * Get the schema for the given schema id. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Schemas$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get the schema string for the given schema id. The response will be the schema string. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Getschema, + options: StreamMethodOptions + ): GaxiosPromise; + getSchema( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Getschema, + options?: MethodOptions + ): GaxiosPromise; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Getschema, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Getschema, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Getschema, + callback: BodyResponseCallback + ): void; + getSchema(callback: BodyResponseCallback): void; + getSchema( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Getschema + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Getschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Getschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/schema').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Get + extends StandardParameters { + /** + * Required. The name of the schema to return. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/schemas/ids/{schema\}` + */ + name?: string; + /** + * Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context. + */ + subject?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Getschema + extends StandardParameters { + /** + * Required. The name of the schema to return. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/schemas/ids/{schema\}` + */ + name?: string; + /** + * Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context. + */ + subject?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List subjects which reference a particular schema id. The response will be an array of subject names. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Schemas$Subjects$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/subjects').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Subjects$List + extends StandardParameters { + /** + * Optional. If true, the response will include soft-deleted subjects. The default is false. + */ + deleted?: boolean; + /** + * Required. The schema resource whose associated subjects are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/schemas/ids/{schema\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/schemas/ids/{schema\}` + */ + parent?: string; + /** + * Optional. The subject to filter the subjects by. + */ + subject?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List the supported schema types. The response will be an array of schema types. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Schemas$Types$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/schemas/types').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Types$List + extends StandardParameters { + /** + * Required. The parent schema registry whose schema types are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List the schema versions for the given schema id. The response will be an array of subject-version pairs as: [{"subject":"subject1", "version":1\}, {"subject":"subject2", "version":2\}]. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Schemas$Versions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Schemas$Versions$List + extends StandardParameters { + /** + * Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false. + */ + deleted?: boolean; + /** + * Required. The schema whose schema versions are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/schemas/ids/{schema\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/schemas/ids/{schema\}` + */ + parent?: string; + /** + * Optional. The subject to filter the subjects by. + */ + subject?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Subjects { + context: APIRequestContext; + versions: Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions; + constructor(context: APIRequestContext) { + this.context = context; + this.versions = + new Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions( + this.context + ); + } + + /** + * Delete a subject. The response will be an array of versions of the deleted subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Subjects$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List subjects in the schema registry. The response will be an array of subject names. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Subjects$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/subjects').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lookup a schema under the specified subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookupVersion( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Lookupversion, + options: StreamMethodOptions + ): GaxiosPromise; + lookupVersion( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Lookupversion, + options?: MethodOptions + ): GaxiosPromise; + lookupVersion( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Lookupversion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupVersion( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Lookupversion, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupVersion( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Lookupversion, + callback: BodyResponseCallback + ): void; + lookupVersion(callback: BodyResponseCallback): void; + lookupVersion( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Lookupversion + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Lookupversion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Lookupversion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Delete + extends StandardParameters { + /** + * Required. The name of the subject to delete. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}` + */ + name?: string; + /** + * Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft-deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete. + */ + permanent?: boolean; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$List + extends StandardParameters { + /** + * Optional. If true, the response will include soft-deleted subjects. The default is false. + */ + deleted?: boolean; + /** + * Required. The parent schema registry/context whose subjects are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}` + */ + parent?: string; + /** + * Optional. The context to filter the subjects by, in the format of `:.{context\}:`. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context. + */ + subjectPrefix?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Lookupversion + extends StandardParameters { + /** + * Required. The subject to lookup the schema in. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LookupVersionRequest; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions { + context: APIRequestContext; + referencedby: Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby; + constructor(context: APIRequestContext) { + this.context = context; + this.referencedby = + new Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby( + this.context + ); + } + + /** + * Register a new version under a given subject with the given schema. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Subjects$Versions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete a version of a subject. The response will be the deleted version id. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Subjects$Versions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get a versioned schema (schema with subject/version) of a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Subjects$Versions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get the schema string only for a version of a subject. The response will be the schema string. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Getschema, + options: StreamMethodOptions + ): GaxiosPromise; + getSchema( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Getschema, + options?: MethodOptions + ): GaxiosPromise; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Getschema, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Getschema, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Getschema, + callback: BodyResponseCallback + ): void; + getSchema(callback: BodyResponseCallback): void; + getSchema( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Getschema + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Getschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Getschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/schema').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get all versions of a subject. The response will be an array of versions of the subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Subjects$Versions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Create + extends StandardParameters { + /** + * Required. The subject to create the version for. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateVersionRequest; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Delete + extends StandardParameters { + /** + * Required. The name of the subject version to delete. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}/versions/{version\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}/versions/{version\}` + */ + name?: string; + /** + * Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete. + */ + permanent?: boolean; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Get + extends StandardParameters { + /** + * Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false. + */ + deleted?: boolean; + /** + * Required. The name of the subject to return versions. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}/versions/{version\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}/versions/{version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Getschema + extends StandardParameters { + /** + * Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false. + */ + deleted?: boolean; + /** + * Required. The name of the subject to return versions. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}/versions/{version\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}/versions/{version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$List + extends StandardParameters { + /** + * Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false. + */ + deleted?: boolean; + /** + * Required. The subject whose versions are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get a list of IDs of schemas that reference the schema with the given subject and version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Contexts$Subjects$Versions$Referencedby$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/referencedby').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Contexts$Subjects$Versions$Referencedby$List + extends StandardParameters { + /** + * Required. The version to list referenced by. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}/versions/{version\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}/versions/{version\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Mode { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get mode at global level or for a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Mode$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Mode$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Mode$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Mode$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Mode$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Mode$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Mode$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Mode$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Update mode at global level or for a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Mode$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Projects$Locations$Schemaregistries$Mode$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Mode$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Mode$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Schemaregistries$Mode$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Mode$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Mode$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Mode$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Mode$Get + extends StandardParameters { + /** + * Required. The resource name of the mode. The format is * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/mode/{subject\}: mode for a schema registry, or * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/mode/{subject\}: mode for a specific subject in a specific context + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Mode$Update + extends StandardParameters { + /** + * Required. The resource name of the mode. The format is * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/mode/{subject\}: mode for a schema registry, or * projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/mode/{subject\}: mode for a specific subject in a specific context + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateSchemaModeRequest; + } + + export class Resource$Projects$Locations$Schemaregistries$Schemas { + context: APIRequestContext; + subjects: Resource$Projects$Locations$Schemaregistries$Schemas$Subjects; + types: Resource$Projects$Locations$Schemaregistries$Schemas$Types; + versions: Resource$Projects$Locations$Schemaregistries$Schemas$Versions; + constructor(context: APIRequestContext) { + this.context = context; + this.subjects = + new Resource$Projects$Locations$Schemaregistries$Schemas$Subjects( + this.context + ); + this.types = + new Resource$Projects$Locations$Schemaregistries$Schemas$Types( + this.context + ); + this.versions = + new Resource$Projects$Locations$Schemaregistries$Schemas$Versions( + this.context + ); + } + + /** + * Get the schema for the given schema id. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Schemas$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Schemas$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get the schema string for the given schema id. The response will be the schema string. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Getschema, + options: StreamMethodOptions + ): GaxiosPromise; + getSchema( + params?: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Getschema, + options?: MethodOptions + ): GaxiosPromise; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Getschema, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Getschema, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Getschema, + callback: BodyResponseCallback + ): void; + getSchema(callback: BodyResponseCallback): void; + getSchema( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Schemas$Getschema + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Getschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Getschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/schema').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Schemas$Get + extends StandardParameters { + /** + * Required. The name of the schema to return. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/schemas/ids/{schema\}` + */ + name?: string; + /** + * Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context. + */ + subject?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Schemas$Getschema + extends StandardParameters { + /** + * Required. The name of the schema to return. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/schemas/ids/{schema\}` + */ + name?: string; + /** + * Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context. + */ + subject?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Schemas$Subjects { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List subjects which reference a particular schema id. The response will be an array of subject names. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Schemas$Subjects$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Subjects$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Subjects$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Subjects$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Subjects$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Schemas$Subjects$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Subjects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Subjects$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/subjects').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Schemas$Subjects$List + extends StandardParameters { + /** + * Optional. If true, the response will include soft-deleted subjects. The default is false. + */ + deleted?: boolean; + /** + * Required. The schema resource whose associated subjects are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/schemas/ids/{schema\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/schemas/ids/{schema\}` + */ + parent?: string; + /** + * Optional. The subject to filter the subjects by. + */ + subject?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Schemas$Types { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List the supported schema types. The response will be an array of schema types. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Schemas$Types$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Types$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Types$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Types$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Types$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Schemas$Types$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Types$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Types$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/schemas/types').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Schemas$Types$List + extends StandardParameters { + /** + * Required. The parent schema registry whose schema types are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Schemas$Versions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List the schema versions for the given schema id. The response will be an array of subject-version pairs as: [{"subject":"subject1", "version":1\}, {"subject":"subject2", "version":2\}]. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Schemas$Versions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Versions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Versions$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Schemas$Versions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Schemas$Versions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Schemas$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Schemas$Versions$List + extends StandardParameters { + /** + * Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false. + */ + deleted?: boolean; + /** + * Required. The schema whose schema versions are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/schemas/ids/{schema\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/schemas/ids/{schema\}` + */ + parent?: string; + /** + * Optional. The subject to filter the subjects by. + */ + subject?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Subjects { + context: APIRequestContext; + versions: Resource$Projects$Locations$Schemaregistries$Subjects$Versions; + constructor(context: APIRequestContext) { + this.context = context; + this.versions = + new Resource$Projects$Locations$Schemaregistries$Subjects$Versions( + this.context + ); + } + + /** + * Delete a subject. The response will be an array of versions of the deleted subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Subjects$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Subjects$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List subjects in the schema registry. The response will be an array of subject names. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Subjects$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Subjects$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Subjects$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Subjects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Subjects$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/subjects').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lookup a schema under the specified subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookupVersion( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Lookupversion, + options: StreamMethodOptions + ): GaxiosPromise; + lookupVersion( + params?: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Lookupversion, + options?: MethodOptions + ): GaxiosPromise; + lookupVersion( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Lookupversion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupVersion( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Lookupversion, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupVersion( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Lookupversion, + callback: BodyResponseCallback + ): void; + lookupVersion(callback: BodyResponseCallback): void; + lookupVersion( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Subjects$Lookupversion + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Lookupversion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Lookupversion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Subjects$Delete + extends StandardParameters { + /** + * Required. The name of the subject to delete. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}` + */ + name?: string; + /** + * Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft-deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete. + */ + permanent?: boolean; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Subjects$List + extends StandardParameters { + /** + * Optional. If true, the response will include soft-deleted subjects. The default is false. + */ + deleted?: boolean; + /** + * Required. The parent schema registry/context whose subjects are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}` + */ + parent?: string; + /** + * Optional. The context to filter the subjects by, in the format of `:.{context\}:`. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context. + */ + subjectPrefix?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Subjects$Lookupversion + extends StandardParameters { + /** + * Required. The subject to lookup the schema in. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LookupVersionRequest; + } + + export class Resource$Projects$Locations$Schemaregistries$Subjects$Versions { + context: APIRequestContext; + referencedby: Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby; + constructor(context: APIRequestContext) { + this.context = context; + this.referencedby = + new Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby( + this.context + ); + } + + /** + * Register a new version under a given subject with the given schema. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Subjects$Versions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete a version of a subject. The response will be the deleted version id. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Subjects$Versions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get a versioned schema (schema with subject/version) of a subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Subjects$Versions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get the schema string only for a version of a subject. The response will be the schema string. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Getschema, + options: StreamMethodOptions + ): GaxiosPromise; + getSchema( + params?: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Getschema, + options?: MethodOptions + ): GaxiosPromise; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Getschema, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Getschema, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSchema( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Getschema, + callback: BodyResponseCallback + ): void; + getSchema(callback: BodyResponseCallback): void; + getSchema( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Getschema + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Getschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Getschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/schema').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get all versions of a subject. The response will be an array of versions of the subject. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Subjects$Versions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Create + extends StandardParameters { + /** + * Required. The subject to create the version for. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateVersionRequest; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Delete + extends StandardParameters { + /** + * Required. The name of the subject version to delete. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}/versions/{version\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}/versions/{version\}` + */ + name?: string; + /** + * Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete. + */ + permanent?: boolean; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Get + extends StandardParameters { + /** + * Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false. + */ + deleted?: boolean; + /** + * Required. The name of the subject to return versions. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}/versions/{version\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}/versions/{version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Getschema + extends StandardParameters { + /** + * Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false. + */ + deleted?: boolean; + /** + * Required. The name of the subject to return versions. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}/versions/{version\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}/versions/{version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$List + extends StandardParameters { + /** + * Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false. + */ + deleted?: boolean; + /** + * Required. The subject whose versions are to be listed. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get a list of IDs of schemas that reference the schema with the given subject and version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Schemaregistries$Subjects$Versions$Referencedby$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://managedkafka.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/referencedby').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Schemaregistries$Subjects$Versions$Referencedby$List + extends StandardParameters { + /** + * Required. The version to list referenced by. Structured like: `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/subjects/{subject\}/versions/{version\}` or `projects/{project\}/locations/{location\}/schemaRegistries/{schema_registry\}/contexts/{context\}/subjects/{subject\}/versions/{version\}` + */ + parent?: string; + } } diff --git a/src/apis/memcache/v1.ts b/src/apis/memcache/v1.ts index b396c7a4a2..6e70b98030 100644 --- a/src/apis/memcache/v1.ts +++ b/src/apis/memcache/v1.ts @@ -275,6 +275,10 @@ export namespace memcache_v1 { * consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites). */ consumerDefinedName?: string | null; + /** + * Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required. + */ + consumerProjectNumber?: string | null; /** * Output only. Timestamp when the resource was created. */ @@ -1161,6 +1165,10 @@ export namespace memcache_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). */ diff --git a/src/apis/memcache/v1beta2.ts b/src/apis/memcache/v1beta2.ts index 87350ac032..6b90379ea1 100644 --- a/src/apis/memcache/v1beta2.ts +++ b/src/apis/memcache/v1beta2.ts @@ -288,6 +288,10 @@ export namespace memcache_v1beta2 { * consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites). */ consumerDefinedName?: string | null; + /** + * Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required. + */ + consumerProjectNumber?: string | null; /** * Output only. Timestamp when the resource was created. */ @@ -1182,6 +1186,10 @@ export namespace memcache_v1beta2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). */ diff --git a/src/apis/merchantapi/accounts_v1beta.ts b/src/apis/merchantapi/accounts_v1beta.ts index 8260555550..1a4f0d1d27 100644 --- a/src/apis/merchantapi/accounts_v1beta.ts +++ b/src/apis/merchantapi/accounts_v1beta.ts @@ -231,7 +231,7 @@ export namespace merchantapi_accounts_v1beta { */ accountIdAlias?: string | null; /** - * Identifier. The resource name of the account relationship. + * Identifier. The resource name of the account relationship. Format: `accounts/{account\}/relationships/{relationship\}` */ name?: string | null; /** @@ -272,7 +272,7 @@ export namespace merchantapi_accounts_v1beta { */ mutability?: string | null; /** - * Identifier. The resource name of the account service. + * Identifier. The resource name of the account service. Format: `accounts/{account\}/services/{service\}` */ name?: string | null; /** @@ -537,7 +537,7 @@ export namespace merchantapi_accounts_v1beta { */ export interface Schema$ClaimHomepageRequest { /** - * Optional. When set to `true`, this option removes any existing claim on the requested website and replaces it with a claim from the account that makes the request. + * Optional. When set to `true`, this option removes any existing claim on the requested website from any other account to the account making the request, effectively replacing the previous claim. */ overwrite?: boolean | null; } @@ -1275,7 +1275,7 @@ export namespace merchantapi_accounts_v1beta { resourceType?: string | null; } /** - * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` + * Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a merchant's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `free-listings` * `shopping-ads` * `youtube-shopping-checkout` */ export interface Schema$Program { /** @@ -1785,7 +1785,7 @@ export namespace merchantapi_accounts_v1beta { */ carrierService?: string | null; /** - * Required. Warehouse name. This should match warehouse + * Required. Warehouse name. This should match [warehouse](/merchant/api/reference/rest/accounts_v1beta/accounts.shippingSettings#warehouse) */ warehouse?: string | null; } @@ -3546,7 +3546,7 @@ export namespace merchantapi_accounts_v1beta { } /** - * Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain more details). + * Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message is returned: * PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account. * FAILED_PRECONDITION: - The account is not a Merchant Center account. - Merchant Center account doesn't have a homepage. - Claiming failed (in this case the error message contains more details). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5501,7 +5501,7 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Accounts$Relationships$Get extends StandardParameters { /** - * Required. The resource name of the account relationship to get. + * Required. The resource name of the account relationship to get. Format: `accounts/{account\}/relationships/{relationship\}` */ name?: string; } @@ -5516,14 +5516,14 @@ export namespace merchantapi_accounts_v1beta { */ pageToken?: string; /** - * Required. The parent account of the account relationship to filter by. + * Required. The parent account of the account relationship to filter by. Format: `accounts/{account\}` */ parent?: string; } export interface Params$Resource$Accounts$Relationships$Patch extends StandardParameters { /** - * Identifier. The resource name of the account relationship. + * Identifier. The resource name of the account relationship. Format: `accounts/{account\}/relationships/{relationship\}` */ name?: string; /** @@ -5993,7 +5993,7 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Accounts$Services$Approve extends StandardParameters { /** - * Required. The resource name of the account service to approve. + * Required. The resource name of the account service to approve. Format: `accounts/{account\}/services/{service\}` */ name?: string; @@ -6005,7 +6005,7 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Accounts$Services$Get extends StandardParameters { /** - * Required. The resource name of the account service to get. + * Required. The resource name of the account service to get. Format: `accounts/{account\}/services/{service\}` */ name?: string; } @@ -6020,14 +6020,14 @@ export namespace merchantapi_accounts_v1beta { */ pageToken?: string; /** - * Required. The parent account of the account service to filter by. + * Required. The parent account of the account service to filter by. Format: `accounts/{account\}` */ parent?: string; } export interface Params$Resource$Accounts$Services$Propose extends StandardParameters { /** - * Required. The resource name of the parent account for the service. + * Required. The resource name of the parent account for the service. Format: `accounts/{account\}` */ parent?: string; @@ -6039,7 +6039,7 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Accounts$Services$Reject extends StandardParameters { /** - * Required. The resource name of the account service to reject. + * Required. The resource name of the account service to reject. Format: `accounts/{account\}/services/{service\}` */ name?: string; diff --git a/src/apis/merchantapi/datasources_v1beta.ts b/src/apis/merchantapi/datasources_v1beta.ts index fc45974f1d..a2ec1483fa 100644 --- a/src/apis/merchantapi/datasources_v1beta.ts +++ b/src/apis/merchantapi/datasources_v1beta.ts @@ -558,7 +558,7 @@ export namespace merchantapi_datasources_v1beta { } /** - * Creates the new data source configuration for the given account. + * Creates the new data source configuration for the given account. This method always creates a new data source. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/merchantapi/index.ts b/src/apis/merchantapi/index.ts index 7502aa941a..2e8c5a2ca6 100644 --- a/src/apis/merchantapi/index.ts +++ b/src/apis/merchantapi/index.ts @@ -18,8 +18,10 @@ import {merchantapi_accounts_v1beta} from './accounts_v1beta'; import {merchantapi_conversions_v1beta} from './conversions_v1beta'; import {merchantapi_datasources_v1beta} from './datasources_v1beta'; import {merchantapi_inventories_v1beta} from './inventories_v1beta'; +import {merchantapi_issueresolution_v1beta} from './issueresolution_v1beta'; import {merchantapi_lfp_v1beta} from './lfp_v1beta'; import {merchantapi_notifications_v1beta} from './notifications_v1beta'; +import {merchantapi_ordertracking_v1beta} from './ordertracking_v1beta'; import {merchantapi_products_v1beta} from './products_v1beta'; import {merchantapi_promotions_v1beta} from './promotions_v1beta'; import {merchantapi_quota_v1beta} from './quota_v1beta'; @@ -31,8 +33,10 @@ export const VERSIONS = { conversions_v1beta: merchantapi_conversions_v1beta.Merchantapi, datasources_v1beta: merchantapi_datasources_v1beta.Merchantapi, inventories_v1beta: merchantapi_inventories_v1beta.Merchantapi, + issueresolution_v1beta: merchantapi_issueresolution_v1beta.Merchantapi, lfp_v1beta: merchantapi_lfp_v1beta.Merchantapi, notifications_v1beta: merchantapi_notifications_v1beta.Merchantapi, + ordertracking_v1beta: merchantapi_ordertracking_v1beta.Merchantapi, products_v1beta: merchantapi_products_v1beta.Merchantapi, promotions_v1beta: merchantapi_promotions_v1beta.Merchantapi, quota_v1beta: merchantapi_quota_v1beta.Merchantapi, @@ -64,6 +68,12 @@ export function merchantapi( export function merchantapi( options: merchantapi_inventories_v1beta.Options ): merchantapi_inventories_v1beta.Merchantapi; +export function merchantapi( + version: 'issueresolution_v1beta' +): merchantapi_issueresolution_v1beta.Merchantapi; +export function merchantapi( + options: merchantapi_issueresolution_v1beta.Options +): merchantapi_issueresolution_v1beta.Merchantapi; export function merchantapi( version: 'lfp_v1beta' ): merchantapi_lfp_v1beta.Merchantapi; @@ -76,6 +86,12 @@ export function merchantapi( export function merchantapi( options: merchantapi_notifications_v1beta.Options ): merchantapi_notifications_v1beta.Merchantapi; +export function merchantapi( + version: 'ordertracking_v1beta' +): merchantapi_ordertracking_v1beta.Merchantapi; +export function merchantapi( + options: merchantapi_ordertracking_v1beta.Options +): merchantapi_ordertracking_v1beta.Merchantapi; export function merchantapi( version: 'products_v1beta' ): merchantapi_products_v1beta.Merchantapi; @@ -112,8 +128,10 @@ export function merchantapi< | merchantapi_conversions_v1beta.Merchantapi | merchantapi_datasources_v1beta.Merchantapi | merchantapi_inventories_v1beta.Merchantapi + | merchantapi_issueresolution_v1beta.Merchantapi | merchantapi_lfp_v1beta.Merchantapi | merchantapi_notifications_v1beta.Merchantapi + | merchantapi_ordertracking_v1beta.Merchantapi | merchantapi_products_v1beta.Merchantapi | merchantapi_promotions_v1beta.Merchantapi | merchantapi_quota_v1beta.Merchantapi @@ -130,10 +148,14 @@ export function merchantapi< | merchantapi_datasources_v1beta.Options | 'inventories_v1beta' | merchantapi_inventories_v1beta.Options + | 'issueresolution_v1beta' + | merchantapi_issueresolution_v1beta.Options | 'lfp_v1beta' | merchantapi_lfp_v1beta.Options | 'notifications_v1beta' | merchantapi_notifications_v1beta.Options + | 'ordertracking_v1beta' + | merchantapi_ordertracking_v1beta.Options | 'products_v1beta' | merchantapi_products_v1beta.Options | 'promotions_v1beta' @@ -154,8 +176,10 @@ export {merchantapi_accounts_v1beta}; export {merchantapi_conversions_v1beta}; export {merchantapi_datasources_v1beta}; export {merchantapi_inventories_v1beta}; +export {merchantapi_issueresolution_v1beta}; export {merchantapi_lfp_v1beta}; export {merchantapi_notifications_v1beta}; +export {merchantapi_ordertracking_v1beta}; export {merchantapi_products_v1beta}; export {merchantapi_promotions_v1beta}; export {merchantapi_quota_v1beta}; diff --git a/src/apis/merchantapi/issueresolution_v1beta.ts b/src/apis/merchantapi/issueresolution_v1beta.ts new file mode 100644 index 0000000000..e69039eee4 --- /dev/null +++ b/src/apis/merchantapi/issueresolution_v1beta.ts @@ -0,0 +1,962 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace merchantapi_issueresolution_v1beta { + export interface Options extends GlobalOptions { + version: 'issueresolution_v1beta'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Merchant API + * + * Programmatically manage your Merchant Center Accounts. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const merchantapi = google.merchantapi('issueresolution_v1beta'); + * ``` + */ + export class Merchantapi { + context: APIRequestContext; + issueresolution: Resource$Issueresolution; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.issueresolution = new Resource$Issueresolution(this.context); + } + } + + /** + * An actionable step that can be executed to solve the issue. + */ + export interface Schema$Action { + /** + * Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available. + */ + builtinSimpleAction?: Schema$BuiltInSimpleAction; + /** + * Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the business as specified for given action. They can trigger the action only when they provided all required inputs. + */ + builtinUserInputAction?: Schema$BuiltInUserInputAction; + /** + * Label of the action button. + */ + buttonLabel?: string | null; + /** + * Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the business to the external location where they can perform the action. + */ + externalAction?: Schema$ExternalAction; + /** + * Controlling whether the button is active or disabled. The value is 'false' when the action was already requested or is not available. If the action is not available then a reason will be present. If (your) third-party application shows a disabled button for action that is not available, then it should also show reasons. + */ + isAvailable?: boolean | null; + /** + * List of reasons why the action is not available. The list of reasons is empty if the action is available. If there is only one reason, it can be displayed next to the disabled button. If there are more reasons, all of them should be displayed, for example in a pop-up dialog. + */ + reasons?: Schema$Reason[]; + } + /** + * Flow that can be selected for an action. When a business selects a flow, application should open a dialog with more information and input form. + */ + export interface Schema$ActionFlow { + /** + * Label for the button to trigger the action from the action dialog. For example: "Request review" + */ + dialogButtonLabel?: string | null; + /** + * Important message to be highlighted in the request dialog. For example: "You can only request a review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue and wait a few days before you can request another review." + */ + dialogCallout?: Schema$Callout; + /** + * Message displayed in the request dialog. For example: "Make sure you've fixed all your country-specific issues. If not, you may have to wait 7 days to request another review". There may be an more information to be shown in a tooltip. + */ + dialogMessage?: Schema$TextWithTooltip; + /** + * Title of the request dialog. For example: "Before you request a review" + */ + dialogTitle?: string | null; + /** + * Not for display but need to be sent back for the selected action flow. + */ + id?: string | null; + /** + * A list of input fields. + */ + inputs?: Schema$InputField[]; + /** + * Text value describing the intent for the action flow. It can be used as an input label if business needs to pick one of multiple flows. For example: "I disagree with the issue" + */ + label?: string | null; + } + /** + * Input provided by the business. + */ + export interface Schema$ActionInput { + /** + * Required. Id of the selected action flow. + */ + actionFlowId?: string | null; + /** + * Required. Values for input fields. + */ + inputValues?: Schema$InputValue[]; + } + /** + * Long text from external source. + */ + export interface Schema$AdditionalContent { + /** + * Long text organized into paragraphs. + */ + paragraphs?: string[] | null; + /** + * Title of the additional content; + */ + title?: string | null; + } + /** + * A detailed impact breakdown for a group of regions where the impact of the issue on different shopping destinations is the same. + */ + export interface Schema$Breakdown { + /** + * Human readable, localized description of issue's effect on different targets. Should be rendered as a list. For example: * "Products not showing in ads" * "Products not showing organically" + */ + details?: string[] | null; + /** + * Lists of regions. Should be rendered as a title for this group of details. The full list should be shown to the business. If the list is too long, it is recommended to make it expandable. + */ + regions?: Schema$Region[]; + } + /** + * Action that is implemented and performed in (your) third-party application. Represents various functionality that is expected to be available to business and will help them with resolving the issue. The application should point the business to the place, where they can access the corresponding functionality. If the functionality is not supported, it is recommended to explain the situation to the business and provide them with instructions how to solve the issue. + */ + export interface Schema$BuiltInSimpleAction { + /** + * Long text from an external source that should be available to the business. Present when the type is `SHOW_ADDITIONAL_CONTENT`. + */ + additionalContent?: Schema$AdditionalContent; + /** + * The attribute that needs to be updated. Present when the type is `EDIT_ITEM_ATTRIBUTE`. This field contains a code for attribute, represented in snake_case. You can find a list of product's attributes, with their codes [here](https://support.google.com/merchants/answer/7052112). + */ + attributeCode?: string | null; + /** + * The type of action that represents a functionality that is expected to be available in third-party application. + */ + type?: string | null; + } + /** + * Action that is implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the business. They can start the action only when they provided all required inputs. The application will request processing of the action by calling the [triggeraction method](https://developers.google.com/merchant/api/reference/rest/issueresolution_v1beta/issueresolution/triggeraction). + */ + export interface Schema$BuiltInUserInputAction { + /** + * Contains the action's context that must be included as part of the TriggerActionPayload.action_context in TriggerActionRequest.payload to call the `triggeraction` method. The content should be treated as opaque and must not be modified. + */ + actionContext?: string | null; + /** + * Actions may provide multiple different flows. Business selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed. + */ + flows?: Schema$ActionFlow[]; + } + /** + * An important message that should be highlighted. Usually displayed as a banner. + */ + export interface Schema$Callout { + /** + * A full message that needs to be shown to the business. + */ + fullMessage?: Schema$TextWithTooltip; + /** + * Can be used to render messages with different severity in different styles. Snippets off all types contain important information that should be displayed to the business. + */ + styleHint?: string | null; + } + /** + * Checkbox input allows the business to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). If the business checks the box, the input value for the field is `true`, otherwise it is `false`. This type of input is often used as a confirmation that the business completed required steps before they are allowed to start the action. In such a case, the input field is marked as required and the button to trigger the action should stay disabled until the business checks the box. + */ + export interface Schema$CheckboxInput {} + /** + * Value for checkbox input field. + */ + export interface Schema$CheckboxInputValue { + /** + * Required. True if the business checked the box field. False otherwise. + */ + value?: boolean | null; + } + /** + * Choice input allows the business to select one of the offered choices. Some choices may be linked to additional input fields that should be displayed under or next to the choice option. The value for the additional input field needs to be provided only when the specific choice is selected by the the business. For example, additional input field can be hidden or disabled until the business selects the specific choice. + */ + export interface Schema$ChoiceInput { + /** + * A list of choices. Only one option can be selected. + */ + options?: Schema$ChoiceInputOption[]; + } + /** + * A choice that the business can select. + */ + export interface Schema$ChoiceInputOption { + /** + * Input that should be displayed when this option is selected. The additional input will not contain a `ChoiceInput`. + */ + additionalInput?: Schema$InputField; + /** + * Not for display but need to be sent back for the selected choice option. + */ + id?: string | null; + /** + * Short description of the choice option. There may be more information to be shown as a tooltip. + */ + label?: Schema$TextWithTooltip; + } + /** + * Value for choice input field. + */ + export interface Schema$ChoiceInputValue { + /** + * Required. Id of the option that was selected by the business. + */ + choiceInputOptionId?: string | null; + } + /** + * Action that is implemented and performed outside of the third-party application. It should redirect the business to the provided URL of an external system where they can perform the action. For example to request a review in the Merchant Center. + */ + export interface Schema$ExternalAction { + /** + * The type of external action. + */ + type?: string | null; + /** + * URL to external system, for example Merchant Center, where the business can perform the action. + */ + uri?: string | null; + } + /** + * Overall impact of the issue. + */ + export interface Schema$Impact { + /** + * Detailed impact breakdown. Explains the types of restriction the issue has in different shopping destinations and territory. If present, it should be rendered to the business. Can be shown as a mouse over dropdown or a dialog. Each breakdown item represents a group of regions with the same impact details. + */ + breakdowns?: Schema$Breakdown[]; + /** + * Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the business. For example: "Disapproves 90k offers in 25 countries" + */ + message?: string | null; + /** + * The severity of the issue. + */ + severity?: string | null; + } + /** + * Input field that needs to be available to the business. If the field is marked as required, then a value needs to be provided for a successful processing of the request. + */ + export interface Schema$InputField { + /** + * Input field to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). + */ + checkboxInput?: Schema$CheckboxInput; + /** + * Input field to select one of the offered choices. Corresponds to the [html input type=radio](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.radio.html#input.radio). + */ + choiceInput?: Schema$ChoiceInput; + /** + * Not for display but need to be sent back for the given input field. + */ + id?: string | null; + /** + * Input field label. There may be more information to be shown in a tooltip. + */ + label?: Schema$TextWithTooltip; + /** + * Whether the field is required. The action button needs to stay disabled till values for all required fields are provided. + */ + required?: boolean | null; + /** + * Input field to provide text information. Corresponds to the [html input type=text](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text) or [html textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea). + */ + textInput?: Schema$TextInput; + } + /** + * Input provided by the business for input field. + */ + export interface Schema$InputValue { + /** + * Value for checkbox input field. + */ + checkboxInputValue?: Schema$CheckboxInputValue; + /** + * Value for choice input field. + */ + choiceInputValue?: Schema$ChoiceInputValue; + /** + * Required. Id of the corresponding input field. + */ + inputFieldId?: string | null; + /** + * Value for text input field. + */ + textInputValue?: Schema$TextInputValue; + } + /** + * The change that happened to the product including old value, new value, country code as the region code and reporting context. + */ + export interface Schema$ProductChange { + /** + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) + */ + newValue?: string | null; + /** + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) + */ + oldValue?: string | null; + /** + * Countries that have the change (if applicable). Represented in the ISO 3166 format. + */ + regionCode?: string | null; + /** + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) + */ + reportingContext?: string | null; + } + /** + * The message that the merchant will receive to notify about product status change event + */ + export interface Schema$ProductStatusChangeMessage { + /** + * The target account that owns the entity that changed. Format : `accounts/{merchant_id\}` + */ + account?: string | null; + /** + * The attribute in the resource that changed, in this case it will be always `Status`. + */ + attribute?: string | null; + /** + * A message to describe the change that happened to the product + */ + changes?: Schema$ProductChange[]; + /** + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + */ + expirationTime?: string | null; + /** + * The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id\}` + */ + managingAccount?: string | null; + /** + * The product name. Format: `accounts/{account\}/products/{product\}` + */ + resource?: string | null; + /** + * The product id. + */ + resourceId?: string | null; + /** + * The resource that changed, in this case it will always be `Product`. + */ + resourceType?: string | null; + } + /** + * A single reason why the action is not available. + */ + export interface Schema$Reason { + /** + * Optional. An action that needs to be performed to solve the problem represented by this reason. This action will always be available. Should be rendered as a link or button next to the summarizing message. For example, the review may be available only once the business configure all required attributes. In such a situation this action can be a link to the form, where they can fill the missing attribute to unblock the main action. + */ + action?: Schema$Action; + /** + * Detailed explanation of the reason. Should be displayed as a hint if present. + */ + detail?: string | null; + /** + * Messages summarizing the reason, why the action is not available. For example: "Review requested on Jan 03. Review requests can take a few days to complete." + */ + message?: string | null; + } + /** + * Region with code and localized name. + */ + export interface Schema$Region { + /** + * The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) + */ + code?: string | null; + /** + * The localized name of the region. For region with code='001' the value is 'All countries' or the equivalent in other languages. + */ + name?: string | null; + } + /** + * Response containing an issue resolution content and actions for listed account issues. + */ + export interface Schema$RenderAccountIssuesResponse { + /** + * List of account issues for a given account. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered. + */ + renderedIssues?: Schema$RenderedIssue[]; + } + /** + * An issue affecting specific business or their product. + */ + export interface Schema$RenderedIssue { + /** + * A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue. Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue. + */ + actions?: Schema$Action[]; + /** + * Clarifies the severity of the issue. The summarizing message, if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue. The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement. Issues with different severity can be styled differently. They may use a different color or icon to signal the difference between `ERROR`, `WARNING` and `INFO`. + */ + impact?: Schema$Impact; + /** + * Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class. + */ + prerenderedContent?: string | null; + /** + * Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. + */ + prerenderedOutOfCourtDisputeSettlement?: string | null; + /** + * Title of the issue. + */ + title?: string | null; + } + /** + * The payload for configuring how the content should be rendered. + */ + export interface Schema$RenderIssuesRequestPayload { + /** + * Optional. How the detailed content should be returned. Default option is to return the content as a pre-rendered HTML text. + */ + contentOption?: string | null; + /** + * Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points the business to Merchant Center where they can request the action. + */ + userInputActionOption?: string | null; + } + /** + * Response containing an issue resolution content and actions for listed product issues. + */ + export interface Schema$RenderProductIssuesResponse { + /** + * List of issues for a given product. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered. + */ + renderedIssues?: Schema$RenderedIssue[]; + } + /** + * Text input allows the business to provide a text value. + */ + export interface Schema$TextInput { + /** + * Additional info regarding the field to be displayed to the business. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip. + */ + additionalInfo?: Schema$TextWithTooltip; + /** + * Text to be used as the [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the input. + */ + ariaLabel?: string | null; + /** + * Information about the required format. If present, it should be shown close to the input field to help the business to provide a correct value. For example: "VAT numbers should be in a format similar to SK9999999999" + */ + formatInfo?: string | null; + /** + * Type of the text input + */ + type?: string | null; + } + /** + * Value for text input field. + */ + export interface Schema$TextInputValue { + /** + * Required. Text provided by the business. + */ + value?: string | null; + } + /** + * Block of text that may contain a tooltip with more information. + */ + export interface Schema$TextWithTooltip { + /** + * Value of the tooltip as a simple text. + */ + simpleTooltipValue?: string | null; + /** + * Value of the message as a simple text. + */ + simpleValue?: string | null; + /** + * The suggested type of an icon for tooltip, if a tooltip is present. + */ + tooltipIconStyle?: string | null; + } + /** + * The payload for the triggered action. + */ + export interface Schema$TriggerActionPayload { + /** + * Required. The context from the selected action. The value is obtained from rendered issues and needs to be sent back to identify the action that is being triggered. + */ + actionContext?: string | null; + /** + * Required. Input provided by the business. + */ + actionInput?: Schema$ActionInput; + } + /** + * Response informing about the started action. + */ + export interface Schema$TriggerActionResponse { + /** + * The message for the business. + */ + message?: string | null; + } + + export class Resource$Issueresolution { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + renderaccountissues( + params: Params$Resource$Issueresolution$Renderaccountissues, + options: StreamMethodOptions + ): GaxiosPromise; + renderaccountissues( + params?: Params$Resource$Issueresolution$Renderaccountissues, + options?: MethodOptions + ): GaxiosPromise; + renderaccountissues( + params: Params$Resource$Issueresolution$Renderaccountissues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + renderaccountissues( + params: Params$Resource$Issueresolution$Renderaccountissues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + renderaccountissues( + params: Params$Resource$Issueresolution$Renderaccountissues, + callback: BodyResponseCallback + ): void; + renderaccountissues( + callback: BodyResponseCallback + ): void; + renderaccountissues( + paramsOrCallback?: + | Params$Resource$Issueresolution$Renderaccountissues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Issueresolution$Renderaccountissues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Issueresolution$Renderaccountissues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/issueresolution/v1beta/{+name}:renderaccountissues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + renderproductissues( + params: Params$Resource$Issueresolution$Renderproductissues, + options: StreamMethodOptions + ): GaxiosPromise; + renderproductissues( + params?: Params$Resource$Issueresolution$Renderproductissues, + options?: MethodOptions + ): GaxiosPromise; + renderproductissues( + params: Params$Resource$Issueresolution$Renderproductissues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + renderproductissues( + params: Params$Resource$Issueresolution$Renderproductissues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + renderproductissues( + params: Params$Resource$Issueresolution$Renderproductissues, + callback: BodyResponseCallback + ): void; + renderproductissues( + callback: BodyResponseCallback + ): void; + renderproductissues( + paramsOrCallback?: + | Params$Resource$Issueresolution$Renderproductissues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Issueresolution$Renderproductissues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Issueresolution$Renderproductissues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/issueresolution/v1beta/{+name}:renderproductissues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + triggeraction( + params: Params$Resource$Issueresolution$Triggeraction, + options: StreamMethodOptions + ): GaxiosPromise; + triggeraction( + params?: Params$Resource$Issueresolution$Triggeraction, + options?: MethodOptions + ): GaxiosPromise; + triggeraction( + params: Params$Resource$Issueresolution$Triggeraction, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + triggeraction( + params: Params$Resource$Issueresolution$Triggeraction, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + triggeraction( + params: Params$Resource$Issueresolution$Triggeraction, + callback: BodyResponseCallback + ): void; + triggeraction( + callback: BodyResponseCallback + ): void; + triggeraction( + paramsOrCallback?: + | Params$Resource$Issueresolution$Triggeraction + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Issueresolution$Triggeraction; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Issueresolution$Triggeraction; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/issueresolution/v1beta/{+name}:triggeraction' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Issueresolution$Renderaccountissues + extends StandardParameters { + /** + * Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize issue resolution content. If not set, the result will be in default language `en-US`. + */ + languageCode?: string; + /** + * Required. The account to fetch issues for. Format: `accounts/{account\}` + */ + name?: string; + /** + * Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC. + */ + timeZone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RenderIssuesRequestPayload; + } + export interface Params$Resource$Issueresolution$Renderproductissues + extends StandardParameters { + /** + * Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize an issue resolution content. If not set, the result will be in default language `en-US`. + */ + languageCode?: string; + /** + * Required. The name of the product to fetch issues for. Format: `accounts/{account\}/products/{product\}` + */ + name?: string; + /** + * Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in an issue resolution content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC. + */ + timeZone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RenderIssuesRequestPayload; + } + export interface Params$Resource$Issueresolution$Triggeraction + extends StandardParameters { + /** + * Optional. Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) used to localize the response. If not set, the result will be in default language `en-US`. + */ + languageCode?: string; + /** + * Required. The business's account that is triggering the action. Format: `accounts/{account\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TriggerActionPayload; + } +} diff --git a/src/apis/merchantapi/ordertracking_v1beta.ts b/src/apis/merchantapi/ordertracking_v1beta.ts new file mode 100644 index 0000000000..ed2ffa30fd --- /dev/null +++ b/src/apis/merchantapi/ordertracking_v1beta.ts @@ -0,0 +1,525 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace merchantapi_ordertracking_v1beta { + export interface Options extends GlobalOptions { + version: 'ordertracking_v1beta'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Merchant API + * + * Programmatically manage your Merchant Center Accounts. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const merchantapi = google.merchantapi('ordertracking_v1beta'); + * ``` + */ + export class Merchantapi { + context: APIRequestContext; + accounts: Resource$Accounts; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.accounts = new Resource$Accounts(this.context); + } + } + + /** + * Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. + */ + export interface Schema$DateTime { + /** + * Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. + */ + day?: number | null; + /** + * Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + */ + minutes?: number | null; + /** + * Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. + */ + month?: number | null; + /** + * Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. + */ + nanos?: number | null; + /** + * Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + /** + * Time zone. + */ + timeZone?: Schema$TimeZone; + /** + * UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 \}. + */ + utcOffset?: string | null; + /** + * Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. + */ + year?: number | null; + } + /** + * The line items of the order. + */ + export interface Schema$LineItemDetails { + /** + * Optional. Brand of the product. + */ + brand?: string | null; + /** + * Optional. The Global Trade Item Number. + */ + gtin?: string | null; + /** + * Required. The ID for this line item. + */ + lineItemId?: string | null; + /** + * Optional. The manufacturer part number. + */ + mpn?: string | null; + /** + * Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId. + */ + productId?: string | null; + /** + * Optional. Plain text title of this product. + */ + productTitle?: string | null; + /** + * Required. The quantity of the line item in the order. + */ + quantity?: string | null; + } + /** + * Represents a business trade from which signals are extracted, such as shipping. + */ + export interface Schema$OrderTrackingSignal { + /** + * Optional. The shipping fee of the order; this value should be set to zero in the case of free shipping. + */ + customerShippingFee?: Schema$Price; + /** + * Optional. The delivery postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response. + */ + deliveryPostalCode?: string | null; + /** + * Optional. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination. + */ + deliveryRegionCode?: string | null; + /** + * Required. Information about line items in the order. + */ + lineItems?: Schema$LineItemDetails[]; + /** + * Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals). + */ + merchantId?: string | null; + /** + * Required. The time when the order was created on the businesses side. Include the year and timezone string, if available. + */ + orderCreatedTime?: Schema$DateTime; + /** + * Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response. + */ + orderId?: string | null; + /** + * Output only. The ID that uniquely identifies this order tracking signal. + */ + orderTrackingSignalId?: string | null; + /** + * Optional. The mapping of the line items to the shipment information. + */ + shipmentLineItemMapping?: Schema$ShipmentLineItemMapping[]; + /** + * Required. The shipping information for the order. + */ + shippingInfo?: Schema$ShippingInfo[]; + } + /** + * The price represented as a number and currency. + */ + export interface Schema$Price { + /** + * The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + */ + amountMicros?: string | null; + /** + * The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + */ + currencyCode?: string | null; + } + /** + * The change that happened to the product including old value, new value, country code as the region code and reporting context. + */ + export interface Schema$ProductChange { + /** + * The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) + */ + newValue?: string | null; + /** + * The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``) + */ + oldValue?: string | null; + /** + * Countries that have the change (if applicable). Represented in the ISO 3166 format. + */ + regionCode?: string | null; + /** + * Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum) + */ + reportingContext?: string | null; + } + /** + * The message that the merchant will receive to notify about product status change event + */ + export interface Schema$ProductStatusChangeMessage { + /** + * The target account that owns the entity that changed. Format : `accounts/{merchant_id\}` + */ + account?: string | null; + /** + * The attribute in the resource that changed, in this case it will be always `Status`. + */ + attribute?: string | null; + /** + * A message to describe the change that happened to the product + */ + changes?: Schema$ProductChange[]; + /** + * The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications. + */ + eventTime?: string | null; + /** + * Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event. + */ + expirationTime?: string | null; + /** + * The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id\}` + */ + managingAccount?: string | null; + /** + * The product name. Format: `accounts/{account\}/products/{product\}` + */ + resource?: string | null; + /** + * The product id. + */ + resourceId?: string | null; + /** + * The resource that changed, in this case it will always be `Product`. + */ + resourceType?: string | null; + } + /** + * Represents how many items are in the shipment for the given shipment_id and line_item_id. + */ + export interface Schema$ShipmentLineItemMapping { + /** + * Required. The line item ID. + */ + lineItemId?: string | null; + /** + * Required. The line item quantity in the shipment. + */ + quantity?: string | null; + /** + * Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. + */ + shipmentId?: string | null; + } + /** + * The shipping information for the order. + */ + export interface Schema$ShippingInfo { + /** + * Optional. The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name. + */ + actualDeliveryTime?: Schema$DateTime; + /** + * Optional. The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time. + */ + carrier?: string | null; + /** + * Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc. + */ + carrierService?: string | null; + /** + * Optional. The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name. + */ + earliestDeliveryPromiseTime?: Schema$DateTime; + /** + * Optional. The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name. + */ + latestDeliveryPromiseTime?: Schema$DateTime; + /** + * Required. The origin postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response. + */ + originPostalCode?: string | null; + /** + * Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin. + */ + originRegionCode?: string | null; + /** + * Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. + */ + shipmentId?: string | null; + /** + * Optional. The time when the shipment was shipped. Include the year and timezone string, if available. + */ + shippedTime?: Schema$DateTime; + /** + * Required. The status of the shipment. + */ + shippingStatus?: string | null; + /** + * Optional. The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time. + */ + trackingId?: string | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone. For example "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number. For example "2019a". + */ + version?: string | null; + } + + export class Resource$Accounts { + context: APIRequestContext; + ordertrackingsignals: Resource$Accounts$Ordertrackingsignals; + constructor(context: APIRequestContext) { + this.context = context; + this.ordertrackingsignals = new Resource$Accounts$Ordertrackingsignals( + this.context + ); + } + } + + export class Resource$Accounts$Ordertrackingsignals { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates new order tracking signal. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Accounts$Ordertrackingsignals$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Accounts$Ordertrackingsignals$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Accounts$Ordertrackingsignals$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Ordertrackingsignals$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Ordertrackingsignals$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Accounts$Ordertrackingsignals$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Ordertrackingsignals$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Ordertrackingsignals$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/ordertracking/v1beta/{+parent}/ordertrackingsignals' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Ordertrackingsignals$Create + extends StandardParameters { + /** + * Output only. The ID that uniquely identifies this order tracking signal. + */ + orderTrackingSignalId?: string; + /** + * Required. The account of the business for which the order signal is created. Format: accounts/{account\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$OrderTrackingSignal; + } +} diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index 090430afe9..eafee5d4eb 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -800,6 +800,10 @@ export namespace metastore_v1 { */ hourOfDay?: number | null; } + /** + * This is proto2's version of MessageSet.DEPRECATED: DO NOT USE FOR NEW FIELDS.If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use Any instead.MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2.This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. + */ + export interface Schema$MessageSet {} /** * The details of a metadata export operation. */ @@ -1310,6 +1314,31 @@ export namespace metastore_v1 { */ message?: string | null; } + /** + * Wire-format for a Status object + */ + export interface Schema$StatusProto { + /** + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; + */ + code?: number | null; + /** + * Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; + */ + messageSet?: Schema$MessageSet; + /** + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs + */ + space?: string | null; + } /** * Telemetry Configuration for the Dataproc Metastore service. */ diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index f7917a7310..e4b4cdad15 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -853,6 +853,10 @@ export namespace metastore_v1alpha { */ hourOfDay?: number | null; } + /** + * This is proto2's version of MessageSet.DEPRECATED: DO NOT USE FOR NEW FIELDS.If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use Any instead.MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2.This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. + */ + export interface Schema$MessageSet {} /** * The details of a metadata export operation. */ @@ -1416,6 +1420,31 @@ export namespace metastore_v1alpha { */ message?: string | null; } + /** + * Wire-format for a Status object + */ + export interface Schema$StatusProto { + /** + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; + */ + code?: number | null; + /** + * Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; + */ + messageSet?: Schema$MessageSet; + /** + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs + */ + space?: string | null; + } /** * Telemetry Configuration for the Dataproc Metastore service. */ diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index fd9239c48c..2c70c02187 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -853,6 +853,10 @@ export namespace metastore_v1beta { */ hourOfDay?: number | null; } + /** + * This is proto2's version of MessageSet.DEPRECATED: DO NOT USE FOR NEW FIELDS.If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use Any instead.MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2.This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. + */ + export interface Schema$MessageSet {} /** * The details of a metadata export operation. */ @@ -1416,6 +1420,31 @@ export namespace metastore_v1beta { */ message?: string | null; } + /** + * Wire-format for a Status object + */ + export interface Schema$StatusProto { + /** + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; + */ + code?: number | null; + /** + * Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; + */ + messageSet?: Schema$MessageSet; + /** + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs + */ + space?: string | null; + } /** * Telemetry Configuration for the Dataproc Metastore service. */ diff --git a/src/apis/migrationcenter/v1.ts b/src/apis/migrationcenter/v1.ts index ac7723edcd..91cce0d892 100644 --- a/src/apis/migrationcenter/v1.ts +++ b/src/apis/migrationcenter/v1.ts @@ -445,6 +445,10 @@ export namespace migrationcenter_v1 { * Optional. When this value is set to `true` the request is a no-op for non-existing assets. See https://google.aip.dev/135#delete-if-existing for additional details. Default value is `false`. */ allowMissing?: boolean | null; + /** + * Optional. Optional cascading rules for deleting related assets. + */ + cascadingRules?: Schema$CascadingRule[]; /** * Required. The IDs of the assets to delete. A maximum of 1000 assets can be deleted in a batch. Format: projects/{project\}/locations/{location\}/assets/{name\}. */ @@ -501,6 +505,19 @@ export namespace migrationcenter_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * Cascading rule for related logical DBs. + */ + export interface Schema$CascadeLogicalDBsRule {} + /** + * Specifies cascading rules for traversing relations. + */ + export interface Schema$CascadingRule { + /** + * Cascading rule for related logical DBs. + */ + cascadeLogicalDbs?: Schema$CascadeLogicalDBsRule; + } /** * Compute engine migration target. */ diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index 6d37e9ef53..5be69584b7 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -1469,7 +1469,7 @@ export namespace migrationcenter_v1alpha1 { */ totalFreeBytes?: string | null; /** - * VMware disk details. + * VMware disk details. Deprecated */ vmwareConfig?: Schema$VmwareDiskConfig; } diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index de8513574b..feebb3cf72 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -576,7 +576,7 @@ export namespace monitoring_v3 { */ export interface Schema$Criteria { /** - * Optional. The filter string to match on Alert fields when silencing the alerts. It follows the standard https://google.aip.dev/160 syntax. A filter string used to apply the snooze to specific incidents that have matching filter values. Filters can be defined for snoozes that apply to one alerting policy. Filters must be a string formatted as one or more resource labels with specific label values. If multiple resource labels are used, then they must be connected with an AND operator. For example, the following filter applies the snooze to incidents that have an instance ID of 1234567890 and a zone of us-central1-a: resource.labels.instance_id="1234567890" AND resource.labels.zone="us-central1-a" + * Optional. When you define a snooze, you can also define a filter for that snooze. The filter is a string containing one or more key-value pairs. The string uses the standard https://google.aip.dev/160 filter syntax. If you define a filter for a snooze, then the snooze can only apply to one alert policy. When the snooze is active, incidents won't be created when the incident would have key-value pairs (labels) that match those specified by the filter in the snooze.Snooze filters support resource, metric, and metadata labels. If multiple labels are used, then they must be connected with an AND operator. For example, the following filter applies the snooze to incidents that have a resource label with an instance ID of "1234567890", a metric label with an instance name of "group", a metadata user label with a key of "foo" and a value of "bar", and a metadata system label with a key of "region" and a value of "us-central1": "filter": "resource.labels.instance_id=\"1234567890\" AND metric.labels.instance_name=\"test_group\" AND metadata.user_labels.foo=\"bar\" AND metadata.system_labels.region=\"us-central1\"" */ filter?: string | null; /** diff --git a/src/apis/netapp/v1.ts b/src/apis/netapp/v1.ts index 3e56bab4ae..ac24b6a6a4 100644 --- a/src/apis/netapp/v1.ts +++ b/src/apis/netapp/v1.ts @@ -241,6 +241,10 @@ export namespace netapp_v1 { * A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. */ description?: string | null; + /** + * Output only. The time until which the backup is not deletable. + */ + enforcedRetentionEndTime?: string | null; /** * Resource labels to represent user provided metadata. */ @@ -344,6 +348,31 @@ export namespace netapp_v1 { */ weeklyBackupLimit?: number | null; } + /** + * Retention policy for backups in the backup vault + */ + export interface Schema$BackupRetentionPolicy { + /** + * Required. Minimum retention duration in days for backups in the backup vault. + */ + backupMinimumEnforcedRetentionDays?: number | null; + /** + * Optional. Indicates if the daily backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. + */ + dailyBackupImmutable?: boolean | null; + /** + * Optional. Indicates if the manual backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. + */ + manualBackupImmutable?: boolean | null; + /** + * Optional. Indicates if the monthly backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. + */ + monthlyBackupImmutable?: boolean | null; + /** + * Optional. Indicates if the weekly backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. + */ + weeklyBackupImmutable?: boolean | null; + } /** * A NetApp BackupVault. */ @@ -352,6 +381,10 @@ export namespace netapp_v1 { * Optional. Region where the backups are stored. Format: `projects/{project_id\}/locations/{location\}` */ backupRegion?: string | null; + /** + * Optional. Backup retention policy defining the retenton of backups. + */ + backupRetentionPolicy?: Schema$BackupRetentionPolicy; /** * Optional. Type of backup vault to be created. Default is IN_REGION. */ @@ -1232,6 +1265,10 @@ export namespace netapp_v1 { * Output only. Create time of the storage pool */ createTime?: string | null; + /** + * Optional. True if using Independent Scaling of capacity and performance (Hyperdisk) By default set to false + */ + customPerformanceEnabled?: boolean | null; /** * Optional. Description of the storage pool */ @@ -1292,6 +1329,14 @@ export namespace netapp_v1 { * Output only. State details of the storage pool */ stateDetails?: string | null; + /** + * Optional. Custom Performance Total IOPS of the pool If not provided, it will be calculated based on the total_throughput_mibps + */ + totalIops?: string | null; + /** + * Optional. Custom Performance Total Throughput of the pool (in MiB/s) + */ + totalThroughputMibps?: string | null; /** * Output only. Allocated size of all volumes in GIB in the storage pool */ @@ -1355,7 +1400,7 @@ export namespace netapp_v1 { */ totalTransferDuration?: string | null; /** - * Cumulative bytes trasferred so far for the replication relatinonship. + * Cumulative bytes transferred so far for the replication relationship. */ transferBytes?: string | null; /** diff --git a/src/apis/netapp/v1beta1.ts b/src/apis/netapp/v1beta1.ts index 5ab6b6535f..ca35e2f9f5 100644 --- a/src/apis/netapp/v1beta1.ts +++ b/src/apis/netapp/v1beta1.ts @@ -241,6 +241,10 @@ export namespace netapp_v1beta1 { * A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. */ description?: string | null; + /** + * Output only. The time until which the backup is not deletable. + */ + enforcedRetentionEndTime?: string | null; /** * Resource labels to represent user provided metadata. */ @@ -344,6 +348,31 @@ export namespace netapp_v1beta1 { */ weeklyBackupLimit?: number | null; } + /** + * Retention policy for backups in the backup vault + */ + export interface Schema$BackupRetentionPolicy { + /** + * Required. Minimum retention duration in days for backups in the backup vault. + */ + backupMinimumEnforcedRetentionDays?: number | null; + /** + * Optional. Indicates if the daily backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. + */ + dailyBackupImmutable?: boolean | null; + /** + * Optional. Indicates if the manual backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. + */ + manualBackupImmutable?: boolean | null; + /** + * Optional. Indicates if the monthly backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. + */ + monthlyBackupImmutable?: boolean | null; + /** + * Optional. Indicates if the weekly backups are immutable. Atleast one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. + */ + weeklyBackupImmutable?: boolean | null; + } /** * A NetApp BackupVault. */ @@ -352,6 +381,10 @@ export namespace netapp_v1beta1 { * Optional. Region where the backups are stored. Format: `projects/{project_id\}/locations/{location\}` */ backupRegion?: string | null; + /** + * Optional. Backup retention policy defining the retenton of backups. + */ + backupRetentionPolicy?: Schema$BackupRetentionPolicy; /** * Optional. Type of backup vault to be created. Default is IN_REGION. */ @@ -1240,6 +1273,10 @@ export namespace netapp_v1beta1 { * Optional. Description of the storage pool */ description?: string | null; + /** + * Optional. Flag indicating that the hot-tier threshold will be auto-increased by 10% of the hot-tier when it hits 100%. Default is true. The increment will kick in only if the new size after increment is still less than or equal to storage pool size. + */ + enableHotTierAutoResize?: boolean | null; /** * Output only. Specifies the current pool encryption key source. */ @@ -1248,6 +1285,10 @@ export namespace netapp_v1beta1 { * Deprecated. Used to allow SO pool to access AD or DNS server from other regions. */ globalAccessAllowed?: boolean | null; + /** + * Optional. Total hot tier capacity for the Storage Pool. It is applicable only to Flex service level. It should be less than the minimum storage pool size and cannot be more than the current storage pool size. It cannot be decreased once set. + */ + hotTierSizeGib?: string | null; /** * Optional. Specifies the KMS config to be used for volume encryption. */ @@ -1333,6 +1374,10 @@ export namespace netapp_v1beta1 { * Optional. Time in days to mark the volume's data block as cold and make it eligible for tiering, can be range from 2-183. Default is 31. */ coolingThresholdDays?: number | null; + /** + * Optional. Flag indicating that the hot tier bypass mode is enabled. Default is false. This is only applicable to Flex service level. + */ + hotTierBypassModeEnabled?: boolean | null; /** * Optional. Flag indicating if the volume has tiering policy enable/pause. Default is PAUSED. */ @@ -1367,7 +1412,7 @@ export namespace netapp_v1beta1 { */ totalTransferDuration?: string | null; /** - * Cumulative bytes trasferred so far for the replication relatinonship. + * Cumulative bytes transferred so far for the replication relationship. */ transferBytes?: string | null; /** diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index 1d3a4c6484..3f11cf194c 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -163,6 +163,19 @@ export namespace networkconnectivity_v1 { */ spokeUri?: string | null; } + /** + * Range auto-allocation options, to be optionally used when CIDR block is not explicitly set. + */ + export interface Schema$AllocationOptions { + /** + * Optional. Allocation strategy Not setting this field when the allocation is requested means an implementation defined strategy is used. + */ + allocationStrategy?: string | null; + /** + * Optional. This field must be set only when allocation_strategy is set to RANDOM_FIRST_N_AVAILABLE. The value should be the maximum expected parallelism of range creation requests issued to the same space of peered netwroks. + */ + firstAvailableRangesLookupSize?: number | null; + } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. */ @@ -351,7 +364,7 @@ export namespace networkconnectivity_v1 { */ export interface Schema$Filter { /** - * Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4. + * Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4 and "::/0" if protocol version is IPv6. */ destRange?: string | null; /** @@ -359,11 +372,11 @@ export namespace networkconnectivity_v1 { */ ipProtocol?: string | null; /** - * Required. Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported. IPV6 is supported in preview. + * Required. Internet protocol versions this policy-based route applies to. IPV4 and IPV6 is supported. */ protocolVersion?: string | null; /** - * Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4. + * Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4 and "::/0" if protocol version is IPv6. */ srcRange?: string | null; } @@ -571,6 +584,10 @@ export namespace networkconnectivity_v1 { * The internal range resource for IPAM operations within a VPC network. Used to represent a private address range along with behavioral characteristics of that range (its usage and peering behavior). Networking resources can link to this range if they are created as belonging to it. */ export interface Schema$InternalRange { + /** + * Optional. Range auto-allocation options, may be set only when auto-allocation is selected by not setting ip_cidr_range (and setting prefix_length). + */ + allocationOptions?: Schema$AllocationOptions; /** * Time when the internal range was created. */ @@ -1077,6 +1094,19 @@ export namespace networkconnectivity_v1 { */ vpcNetwork?: string | null; } + /** + * A route next hop that leads to a spoke resource. + */ + export interface Schema$NextHopSpoke { + /** + * Indicates whether site-to-site data transfer is allowed for this spoke resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). Whether this route is accessible to other hybrid spokes with site-to-site data transfer enabled. If this is false, the route is only accessible to VPC spokes of the connected Hub. + */ + siteToSiteDataTransfer?: boolean | null; + /** + * The URI of the spoke resource. + */ + uri?: string | null; + } export interface Schema$NextHopVpcNetwork { /** * The URI of the VPC network resource @@ -1492,6 +1522,10 @@ export namespace networkconnectivity_v1 { * Immutable. The next-hop Router appliance instance for packets on this route. */ nextHopRouterApplianceInstance?: Schema$NextHopRouterApplianceInstance; + /** + * Immutable. The next-hop spoke for packets on this route. + */ + nextHopSpoke?: Schema$NextHopSpoke; /** * Immutable. The destination VPC network for packets on this route. */ @@ -5909,6 +5943,96 @@ export namespace networkconnectivity_v1 { } } + /** + * 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$Internalranges$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Internalranges$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Internalranges$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Internalranges$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Internalranges$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Internalranges$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Internalranges$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Internalranges$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists internal ranges in a given project and location. * @@ -6097,6 +6221,193 @@ export namespace networkconnectivity_v1 { 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$Internalranges$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Internalranges$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Internalranges$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Internalranges$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Internalranges$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Internalranges$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Internalranges$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Internalranges$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Internalranges$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Internalranges$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Internalranges$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Internalranges$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Internalranges$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Internalranges$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Internalranges$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Internalranges$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkconnectivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Internalranges$Create @@ -6137,6 +6448,17 @@ export namespace networkconnectivity_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Internalranges$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$Internalranges$List extends StandardParameters { /** @@ -6180,6 +6502,30 @@ export namespace networkconnectivity_v1 { */ requestBody?: Schema$InternalRange; } + export interface Params$Resource$Projects$Locations$Internalranges$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Internalranges$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } export class Resource$Projects$Locations$Operations { context: APIRequestContext; diff --git a/src/apis/networkconnectivity/v1alpha1.ts b/src/apis/networkconnectivity/v1alpha1.ts index eff859e5c6..6490eba70f 100644 --- a/src/apis/networkconnectivity/v1alpha1.ts +++ b/src/apis/networkconnectivity/v1alpha1.ts @@ -129,7 +129,7 @@ export namespace networkconnectivity_v1alpha1 { */ export interface Schema$AllocationOptions { /** - * Optional. Allocation strategy Not setting this field when the allocation is requested means an implementation defined strategy is used. + * Optional. Allocation strategy. Not setting this field when the allocation is requested means an implementation defined strategy is used. */ allocationStrategy?: string | null; /** diff --git a/src/apis/networksecurity/v1.ts b/src/apis/networksecurity/v1.ts index 481c23a48a..9fe7d92a2f 100644 --- a/src/apis/networksecurity/v1.ts +++ b/src/apis/networksecurity/v1.ts @@ -306,7 +306,7 @@ export namespace networksecurity_v1 { */ export interface Schema$AuthzPolicyAuthzRuleFromRequestSource { /** - * Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the forwarding rule or Gateway. For Application Load Balancers, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or SPIFFE ID, or the subject field in the client's certificate. For Cloud Service Mesh, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or the subject field in the client's certificate. The match can be exact, prefix, suffix, or a substring match. One of exact, prefix, suffix, or contains must be specified. Limited to 5 principals. + * Optional. A list of identities derived from the client's certificate. This field is under development and we don't recommend using it at this time. Limited to 5 principals. */ principals?: Schema$AuthzPolicyAuthzRuleStringMatch[]; /** diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index 89f3a45921..bea0475493 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -306,7 +306,7 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$AuthzPolicyAuthzRuleFromRequestSource { /** - * Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the forwarding rule or Gateway. For Application Load Balancers, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or SPIFFE ID, or the subject field in the client's certificate. For Cloud Service Mesh, each identity is a string whose value is matched against the URI SAN, or DNS SAN, or the subject field in the client's certificate. The match can be exact, prefix, suffix, or a substring match. One of exact, prefix, suffix, or contains must be specified. Limited to 5 principals. + * Optional. A list of identities derived from the client's certificate. This field is under development and we don't recommend using it at this time. Limited to 5 principals. */ principals?: Schema$AuthzPolicyAuthzRuleStringMatch[]; /** diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index 7d726317bf..c8eeee17ec 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -8829,6 +8829,92 @@ export namespace networkservices_v1 { return createAPIRequest(parameters); } } + + /** + * Updates the parameters of a single ServiceBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Servicebindings$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Servicebindings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Servicebindings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Servicebindings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Servicebindings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Servicebindings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Servicebindings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Servicebindings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Servicebindings$Create @@ -8876,6 +8962,22 @@ export namespace networkservices_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Servicebindings$Patch + extends StandardParameters { + /** + * Identifier. Name of the ServiceBinding resource. It matches pattern `projects/x/locations/x/serviceBindings/`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the ServiceBinding resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ServiceBinding; + } export class Resource$Projects$Locations$Servicelbpolicies { context: APIRequestContext; diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index 71ddb4d2c7..fa79b44df0 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -8369,6 +8369,92 @@ export namespace networkservices_v1beta1 { return createAPIRequest(parameters); } } + + /** + * Updates the parameters of a single ServiceBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Servicebindings$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Servicebindings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Servicebindings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Servicebindings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Servicebindings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Servicebindings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Servicebindings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Servicebindings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Servicebindings$Create @@ -8416,6 +8502,22 @@ export namespace networkservices_v1beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Servicebindings$Patch + extends StandardParameters { + /** + * Identifier. Name of the ServiceBinding resource. It matches pattern `projects/x/locations/x/serviceBindings/`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the ServiceBinding resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ServiceBinding; + } export class Resource$Projects$Locations$Servicelbpolicies { context: APIRequestContext; diff --git a/src/apis/notebooks/v1.ts b/src/apis/notebooks/v1.ts index 63988b6c57..59ac06bca0 100644 --- a/src/apis/notebooks/v1.ts +++ b/src/apis/notebooks/v1.ts @@ -1976,6 +1976,10 @@ export namespace notebooks_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). */ diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index 5ae337280e..819a42e383 100644 --- a/src/apis/notebooks/v2.ts +++ b/src/apis/notebooks/v2.ts @@ -217,10 +217,6 @@ export namespace notebooks_v2 { * Optional. Defines the type of technology used by the confidential instance. */ confidentialInstanceType?: string | null; - /** - * Optional. Defines whether the instance should have confidential compute enabled. - */ - enableConfidentialCompute?: boolean | null; } /** * Response for getting WbI configurations in a location @@ -418,6 +414,10 @@ export namespace notebooks_v2 { * Optional. The network interfaces for the VM. Supports only one interface. */ networkInterfaces?: Schema$NetworkInterface[]; + /** + * Optional. Specifies the reservations that this instance can consume from. + */ + reservationAffinity?: Schema$ReservationAffinity; /** * Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account. */ @@ -477,6 +477,10 @@ export namespace notebooks_v2 { * Optional. If true, the notebook instance will not register with the proxy. */ disableProxyAccess?: boolean | null; + /** + * Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance. + */ + enableDeletionProtection?: boolean | null; /** * Optional. Flag that specifies that a notebook can be accessed with third party identity provider. */ @@ -498,7 +502,7 @@ export namespace notebooks_v2 { */ id?: string | null; /** - * Optional. Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance. + * Optional. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance. */ instanceOwners?: string[] | null; /** @@ -719,6 +723,23 @@ export namespace notebooks_v2 { */ vmId?: string | null; } + /** + * A reservation that an instance can consume from. + */ + export interface Schema$ReservationAffinity { + /** + * Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples. + */ + consumeReservationType?: string | null; + /** + * Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value. + */ + key?: string | null; + /** + * Optional. Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project. + */ + values?: string[] | null; + } /** * Request for resetting a notebook instance */ @@ -785,7 +806,7 @@ export namespace notebooks_v2 { */ export interface Schema$ShieldedInstanceConfig { /** - * Optional. Defines whether the VM instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the VM instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the VM instance is created. Enabled by default. + * Optional. Defines whether the VM instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the VM instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the VM instance is created. */ enableIntegrityMonitoring?: boolean | null; /** @@ -793,7 +814,7 @@ export namespace notebooks_v2 { */ enableSecureBoot?: boolean | null; /** - * Optional. Defines whether the VM instance has the vTPM enabled. Enabled by default. + * Optional. Defines whether the VM instance has the vTPM enabled. */ enableVtpm?: boolean | null; } @@ -1147,6 +1168,10 @@ export namespace notebooks_v2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + */ + extraLocationTypes?: string[]; /** * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). */ diff --git a/src/apis/ondemandscanning/v1.ts b/src/apis/ondemandscanning/v1.ts index ce522ef389..c827666adc 100644 --- a/src/apis/ondemandscanning/v1.ts +++ b/src/apis/ondemandscanning/v1.ts @@ -693,6 +693,10 @@ export namespace ondemandscanning_v1 { * The base images the layer is found within. */ baseImages?: Schema$GrafeasV1BaseImage[]; + /** + * The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid + */ + chainId?: string | null; /** * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. */ @@ -888,6 +892,10 @@ export namespace ondemandscanning_v1 { * The base images the layer is found within. */ baseImages?: Schema$BaseImage[]; + /** + * The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid + */ + chainId?: string | null; /** * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. */ @@ -1077,6 +1085,10 @@ export namespace ondemandscanning_v1 { * Describes a specific SBOM reference occurrences. */ sbomReference?: Schema$SBOMReferenceOccurrence; + /** + * Describes a secret. + */ + secret?: Schema$SecretOccurrence; /** * Output only. The time this occurrence was last updated. */ @@ -1441,6 +1453,49 @@ export namespace ondemandscanning_v1 { */ sbomState?: string | null; } + /** + * The location of the secret. + */ + export interface Schema$SecretLocation { + /** + * The secret is found from a file. + */ + fileLocation?: Schema$GrafeasV1FileLocation; + } + /** + * The occurrence provides details of a secret. + */ + export interface Schema$SecretOccurrence { + /** + * Required. Type of secret. + */ + kind?: string | null; + /** + * Optional. Locations where the secret is detected. + */ + locations?: Schema$SecretLocation[]; + /** + * Optional. Status of the secret. + */ + statuses?: Schema$SecretStatus[]; + } + /** + * The status of the secret with a timestamp. + */ + export interface Schema$SecretStatus { + /** + * Optional. Optional message about the status code. + */ + message?: string | null; + /** + * Optional. The status of the secret. + */ + status?: string | null; + /** + * Optional. The time the secret status was last updated. + */ + updateTime?: string | null; + } /** * Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from `public_key_id` to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature `public_key_id` as anything more than a key lookup hint. The `public_key_id` DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The `public_key_id` is not recognized by the verifier. * The public key that `public_key_id` refers to does not verify the signature with respect to the payload. The `signature` contents SHOULD NOT be "attached" (where the payload is included with the serialized `signature` bytes). Verifiers MUST ignore any "attached" payload and only verify signatures with respect to explicitly provided payload (e.g. a `payload` field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature). */ diff --git a/src/apis/ondemandscanning/v1beta1.ts b/src/apis/ondemandscanning/v1beta1.ts index c7c6efa2df..59abcc8019 100644 --- a/src/apis/ondemandscanning/v1beta1.ts +++ b/src/apis/ondemandscanning/v1beta1.ts @@ -689,6 +689,10 @@ export namespace ondemandscanning_v1beta1 { * The base images the layer is found within. */ baseImages?: Schema$GrafeasV1BaseImage[]; + /** + * The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid + */ + chainId?: string | null; /** * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. */ @@ -884,6 +888,10 @@ export namespace ondemandscanning_v1beta1 { * The base images the layer is found within. */ baseImages?: Schema$BaseImage[]; + /** + * The layer chain ID (sha256 hash) of the layer in the container image. https://github.com/opencontainers/image-spec/blob/main/config.md#layer-chainid + */ + chainId?: string | null; /** * The layer build command that was used to build the layer. This may not be found in all layers depending on how the container image is built. */ @@ -1073,6 +1081,10 @@ export namespace ondemandscanning_v1beta1 { * Describes a specific SBOM reference occurrences. */ sbomReference?: Schema$SBOMReferenceOccurrence; + /** + * Describes a secret. + */ + secret?: Schema$SecretOccurrence; /** * Output only. The time this occurrence was last updated. */ @@ -1437,6 +1449,49 @@ export namespace ondemandscanning_v1beta1 { */ sbomState?: string | null; } + /** + * The location of the secret. + */ + export interface Schema$SecretLocation { + /** + * The secret is found from a file. + */ + fileLocation?: Schema$GrafeasV1FileLocation; + } + /** + * The occurrence provides details of a secret. + */ + export interface Schema$SecretOccurrence { + /** + * Required. Type of secret. + */ + kind?: string | null; + /** + * Optional. Locations where the secret is detected. + */ + locations?: Schema$SecretLocation[]; + /** + * Optional. Status of the secret. + */ + statuses?: Schema$SecretStatus[]; + } + /** + * The status of the secret with a timestamp. + */ + export interface Schema$SecretStatus { + /** + * Optional. Optional message about the status code. + */ + message?: string | null; + /** + * Optional. The status of the secret. + */ + status?: string | null; + /** + * Optional. The time the secret status was last updated. + */ + updateTime?: string | null; + } /** * Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from `public_key_id` to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature `public_key_id` as anything more than a key lookup hint. The `public_key_id` DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The `public_key_id` is not recognized by the verifier. * The public key that `public_key_id` refers to does not verify the signature with respect to the payload. The `signature` contents SHOULD NOT be "attached" (where the payload is included with the serialized `signature` bytes). Verifiers MUST ignore any "attached" payload and only verify signatures with respect to explicitly provided payload (e.g. a `payload` field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature). */ diff --git a/src/apis/oracledatabase/v1.ts b/src/apis/oracledatabase/v1.ts index 3395adb0b5..fd1e99b62e 100644 --- a/src/apis/oracledatabase/v1.ts +++ b/src/apis/oracledatabase/v1.ts @@ -150,7 +150,7 @@ export namespace oracledatabase_v1 { */ adminPassword?: string | null; /** - * Optional. The subnet CIDR range for the Autonmous Database. + * Optional. The subnet CIDR range for the Autonomous Database. */ cidr?: string | null; /** @@ -1693,7 +1693,7 @@ export namespace oracledatabase_v1 { stopTime?: Schema$TimeOfDay; } /** - * The source configuration for the standby Autonomnous Database. + * The source configuration for the standby Autonomous Database. */ export interface Schema$SourceConfig { /** @@ -4562,7 +4562,7 @@ export namespace oracledatabase_v1 { */ pageToken?: string; /** - * Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. + * Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. . */ parent?: string; } @@ -4906,6 +4906,10 @@ export namespace oracledatabase_v1 { export interface Params$Resource$Projects$Locations$Giversions$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Only the shape and gi_version fields are supported in this format: `shape="{shape\}"`. + */ + filter?: string; /** * Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. */ diff --git a/src/apis/osconfig/v1.ts b/src/apis/osconfig/v1.ts index 3a5af331d5..ba830b19d4 100644 --- a/src/apis/osconfig/v1.ts +++ b/src/apis/osconfig/v1.ts @@ -785,6 +785,10 @@ export namespace osconfig_v1 { */ vulnerabilityReports?: Schema$VulnerabilityReport[]; } + /** + * This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. + */ + export interface Schema$MessageSet {} /** * Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". */ @@ -1845,6 +1849,31 @@ export namespace osconfig_v1 { */ message?: string | null; } + /** + * Wire-format for a Status object + */ + export interface Schema$StatusProto { + /** + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; + */ + code?: number | null; + /** + * Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; + */ + messageSet?: Schema$MessageSet; + /** + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs + */ + space?: string | null; + } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ diff --git a/src/apis/osconfig/v1alpha.ts b/src/apis/osconfig/v1alpha.ts index 090696e8f2..5e5c593f54 100644 --- a/src/apis/osconfig/v1alpha.ts +++ b/src/apis/osconfig/v1alpha.ts @@ -708,6 +708,10 @@ export namespace osconfig_v1alpha { */ vulnerabilityReports?: Schema$VulnerabilityReport[]; } + /** + * This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. + */ + export interface Schema$MessageSet {} /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1456,6 +1460,31 @@ export namespace osconfig_v1alpha { */ message?: string | null; } + /** + * Wire-format for a Status object + */ + export interface Schema$StatusProto { + /** + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; + */ + code?: number | null; + /** + * Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; + */ + messageSet?: Schema$MessageSet; + /** + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs + */ + space?: string | null; + } /** * This API resource represents the vulnerability report for a specified Compute Engine virtual machine (VM) instance at a given point in time. For more information, see [Vulnerability reports](https://cloud.google.com/compute/docs/instances/os-inventory-management#vulnerability-reports). */ diff --git a/src/apis/osconfig/v1beta.ts b/src/apis/osconfig/v1beta.ts index 9ab0948c61..91987f2680 100644 --- a/src/apis/osconfig/v1beta.ts +++ b/src/apis/osconfig/v1beta.ts @@ -596,6 +596,10 @@ export namespace osconfig_v1beta { */ osVersion?: string | null; } + /** + * This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. + */ + export interface Schema$MessageSet {} /** * Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". */ @@ -1250,6 +1254,31 @@ export namespace osconfig_v1beta { */ script?: string | null; } + /** + * Wire-format for a Status object + */ + export interface Schema$StatusProto { + /** + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; + */ + code?: number | null; + /** + * Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; + */ + messageSet?: Schema$MessageSet; + /** + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs + */ + space?: string | null; + } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ diff --git a/src/apis/osconfig/v2.ts b/src/apis/osconfig/v2.ts index c66c73c1df..df2b5ddaaf 100644 --- a/src/apis/osconfig/v2.ts +++ b/src/apis/osconfig/v2.ts @@ -430,6 +430,10 @@ export namespace osconfig_v2 { */ operations?: Schema$Operation[]; } + /** + * This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. + */ + export interface Schema$MessageSet {} /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1013,6 +1017,31 @@ export namespace osconfig_v2 { */ message?: string | null; } + /** + * Wire-format for a Status object + */ + export interface Schema$StatusProto { + /** + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; + */ + code?: number | null; + /** + * Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; + */ + messageSet?: Schema$MessageSet; + /** + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs + */ + space?: string | null; + } export class Resource$Folders { context: APIRequestContext; @@ -1577,7 +1606,7 @@ export namespace osconfig_v2 { */ name?: string; /** - * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. */ updateMask?: string; @@ -2555,7 +2584,7 @@ export namespace osconfig_v2 { */ name?: string; /** - * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. */ updateMask?: string; @@ -3535,7 +3564,7 @@ export namespace osconfig_v2 { */ name?: string; /** - * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. */ updateMask?: string; diff --git a/src/apis/osconfig/v2beta.ts b/src/apis/osconfig/v2beta.ts index 3cf6502391..9428bbf196 100644 --- a/src/apis/osconfig/v2beta.ts +++ b/src/apis/osconfig/v2beta.ts @@ -430,6 +430,10 @@ export namespace osconfig_v2beta { */ operations?: Schema$Operation[]; } + /** + * This is proto2's version of MessageSet. DEPRECATED: DO NOT USE FOR NEW FIELDS. If you are using editions or proto2, please make your own extendable messages for your use case. If you are using proto3, please use `Any` instead. MessageSet was the implementation of extensions for proto1. When proto2 was introduced, extensions were implemented as a first-class feature. This schema for MessageSet was meant to be a "bridge" solution to migrate MessageSet-bearing messages from proto1 to proto2. This schema has been open-sourced only to facilitate the migration of Google products with MessageSet-bearing messages to open-source environments. + */ + export interface Schema$MessageSet {} /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1013,6 +1017,31 @@ export namespace osconfig_v2beta { */ message?: string | null; } + /** + * Wire-format for a Status object + */ + export interface Schema$StatusProto { + /** + * copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; + */ + canonicalCode?: number | null; + /** + * Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; + */ + code?: number | null; + /** + * Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; + */ + message?: string | null; + /** + * message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; + */ + messageSet?: Schema$MessageSet; + /** + * copybara:strip_begin(b/383363683) Space to which this status belongs copybara:strip_end_and_replace optional string space = 2; // Space to which this status belongs + */ + space?: string | null; + } export class Resource$Folders { context: APIRequestContext; @@ -1577,7 +1606,7 @@ export namespace osconfig_v2beta { */ name?: string; /** - * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. */ updateMask?: string; @@ -2558,7 +2587,7 @@ export namespace osconfig_v2beta { */ name?: string; /** - * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. */ updateMask?: string; @@ -3541,7 +3570,7 @@ export namespace osconfig_v2beta { */ name?: string; /** - * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. + * Optional. The list of fields to merge into the existing policy orchestrator. A special ["*"] field mask can be used to simply replace the entire resource. Otherwise, for all paths referenced in the mask, following merge rules are used: * output only fields are ignored, * primitive fields are replaced, * repeated fields are replaced, * map fields are merged key by key, * message fields are cleared if not set in the request, otherwise they are merged recursively (in particular - message fields set to an empty message has no side effects) If field mask (or its paths) is not specified, it is automatically inferred from the request using following rules: * primitive fields are listed, if set to a non-default value (as there is no way to distinguish between default and unset value), * map and repeated fields are listed, * `google.protobuf.Any` fields are listed, * other message fields are traversed recursively. Note: implicit mask does not allow clearing fields. */ updateMask?: string; diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index 5de5c26670..9c06d0d43c 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -135,7 +135,7 @@ export namespace oslogin_v1alpha { */ export interface Schema$GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest { /** - * The App Engine instance to sign the SSH public key for. Expected format: services/{service\}/versions/{version\}/instances/{instance\} + * The App Engine instance to sign the SSH public key for. Expected format: apps/{app\}/services/{service\}/versions/{version\}/instances/{instance\} */ appEngineInstance?: string | null; /** diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index 44bc73b3b0..bfd1846b04 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -135,7 +135,7 @@ export namespace oslogin_v1beta { */ export interface Schema$GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest { /** - * The App Engine instance to sign the SSH public key for. Expected format: services/{service\}/versions/{version\}/instances/{instance\} + * The App Engine instance to sign the SSH public key for. Expected format: apps/{app\}/services/{service\}/versions/{version\}/instances/{instance\} */ appEngineInstance?: string | null; /** diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index b5d7653263..578966d57d 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -3708,7 +3708,7 @@ export namespace people_v1 { } /** - * Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. + * Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. If making sequential updates to the same person, the etag from the `updateContact` response should be used to avoid failures. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/places/v1.ts b/src/apis/places/v1.ts index 98aed81ed1..a098711a36 100644 --- a/src/apis/places/v1.ts +++ b/src/apis/places/v1.ts @@ -1029,7 +1029,7 @@ export namespace places_v1 { */ directionsUri?: string | null; /** - * A link to show photos of this place. This link is currently not supported on Google Maps Mobile and only works on the web version of Google Maps. + * A link to show reviews of this place on Google Maps. */ photosUri?: string | null; /** @@ -1037,11 +1037,11 @@ export namespace places_v1 { */ placeUri?: string | null; /** - * A link to show reviews of this place. This link is currently not supported on Google Maps Mobile and only works on the web version of Google Maps. + * A link to show reviews of this place on Google Maps. */ reviewsUri?: string | null; /** - * A link to write a review for this place. This link is currently not supported on Google Maps Mobile and only works on the web version of Google Maps. + * A link to write a review for this place on Google Maps. */ writeAReviewUri?: string | null; } @@ -1225,6 +1225,10 @@ export namespace places_v1 { * A link where users can flag a problem with the summary. */ flagContentUri?: string | null; + /** + * A link to show reviews of this place on Google Maps. + */ + reviewsUri?: string | null; /** * The summary of user reviews. */ @@ -1305,23 +1309,6 @@ export namespace places_v1 { * The localized text of the review. */ text?: Schema$GoogleTypeLocalizedText; - /** - * The date when the author visited the place. This is trucated to month. - */ - visitDate?: Schema$GoogleMapsPlacesV1ReviewVisitDate; - } - /** - * The date when the author visited the place. This is trucated to month. - */ - export interface Schema$GoogleMapsPlacesV1ReviewVisitDate { - /** - * The month the author visited the place, e.g. 4. The value is between 1 and 12. - */ - month?: number | null; - /** - * The year the author visited the place, e.g. 2025. - */ - year?: number | null; } /** * Encapsulates a set of optional conditions to satisfy when calculating the routes. diff --git a/src/apis/playintegrity/v1.ts b/src/apis/playintegrity/v1.ts index 019229a9a6..30a6d12f8a 100644 --- a/src/apis/playintegrity/v1.ts +++ b/src/apis/playintegrity/v1.ts @@ -196,6 +196,24 @@ export namespace playintegrity_v1 { */ tokenPayloadExternal?: Schema$TokenPayloadExternal; } + /** + * Request to decode the PC integrity token. + */ + export interface Schema$DecodePcIntegrityTokenRequest { + /** + * Encoded integrity token. + */ + integrityToken?: string | null; + } + /** + * Response containing the decoded PC integrity payload. + */ + export interface Schema$DecodePcIntegrityTokenResponse { + /** + * Plain token payload generated from the decoded integrity token. + */ + tokenPayloadExternal?: Schema$PcTokenPayloadExternal; + } /** * Contains information about the device for which the integrity token was generated, e.g. Android SDK version. */ @@ -256,6 +274,45 @@ export namespace playintegrity_v1 { */ playProtectVerdict?: string | null; } + /** + * Contains the device attestation information. + */ + export interface Schema$PcDeviceIntegrity { + /** + * Details about the integrity of the device the app is running on. + */ + deviceRecognitionVerdict?: string[] | null; + } + /** + * Contains the integrity request information. + */ + export interface Schema$PcRequestDetails { + /** + * Request hash that was provided in the request. + */ + requestHash?: string | null; + /** + * Required. Application package name this attestation was requested for. Note: This field makes no guarantees or promises on the caller integrity. + */ + requestPackageName?: string | null; + /** + * Required. Timestamp, of the integrity application request. + */ + requestTime?: string | null; + } + /** + * Contains PC device attestation details. + */ + export interface Schema$PcTokenPayloadExternal { + /** + * Required. Details about the device integrity. + */ + deviceIntegrity?: Schema$PcDeviceIntegrity; + /** + * Required. Details about the integrity request. + */ + requestDetails?: Schema$PcRequestDetails; + } /** * Recent device activity can help developers identify devices that have exhibited hyperactive attestation activity, which could be a sign of an attack or token farming. */ @@ -595,6 +652,103 @@ export namespace playintegrity_v1 { ); } } + + /** + * Decodes the PC integrity token and returns the PC token payload. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + decodePcIntegrityToken( + params: Params$Resource$V1$Decodepcintegritytoken, + options: StreamMethodOptions + ): GaxiosPromise; + decodePcIntegrityToken( + params?: Params$Resource$V1$Decodepcintegritytoken, + options?: MethodOptions + ): GaxiosPromise; + decodePcIntegrityToken( + params: Params$Resource$V1$Decodepcintegritytoken, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + decodePcIntegrityToken( + params: Params$Resource$V1$Decodepcintegritytoken, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + decodePcIntegrityToken( + params: Params$Resource$V1$Decodepcintegritytoken, + callback: BodyResponseCallback + ): void; + decodePcIntegrityToken( + callback: BodyResponseCallback + ): void; + decodePcIntegrityToken( + paramsOrCallback?: + | Params$Resource$V1$Decodepcintegritytoken + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$V1$Decodepcintegritytoken; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$V1$Decodepcintegritytoken; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://playintegrity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+packageName}:decodePcIntegrityToken' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['packageName'], + pathParams: ['packageName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$V1$Decodeintegritytoken @@ -609,4 +763,16 @@ export namespace playintegrity_v1 { */ requestBody?: Schema$DecodeIntegrityTokenRequest; } + export interface Params$Resource$V1$Decodepcintegritytoken + extends StandardParameters { + /** + * Package name of the app the attached integrity token belongs to. + */ + packageName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DecodePcIntegrityTokenRequest; + } } diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts index a394a8c234..e575e7447e 100644 --- a/src/apis/recaptchaenterprise/v1.ts +++ b/src/apis/recaptchaenterprise/v1.ts @@ -541,6 +541,10 @@ export namespace recaptchaenterprise_v1 { * Output only. Assessment of this transaction for risk of being part of a card testing attack. */ cardTestingVerdict?: Schema$GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict; + /** + * Output only. Reasons why the transaction is probably fraudulent and received a high transaction risk score. + */ + riskReasons?: Schema$GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentRiskReason[]; /** * Output only. Assessment of this transaction for risk of a stolen instrument. */ @@ -568,6 +572,15 @@ export namespace recaptchaenterprise_v1 { */ risk?: number | null; } + /** + * Risk reasons applicable to the Fraud Prevention assessment. + */ + export interface Schema$GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentRiskReason { + /** + * Output only. Risk reasons applicable to the Fraud Prevention assessment. + */ + reason?: string | null; + } /** * Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase. */ diff --git a/src/apis/reseller/v1.ts b/src/apis/reseller/v1.ts index ee4c30a479..8f9588146a 100644 --- a/src/apis/reseller/v1.ts +++ b/src/apis/reseller/v1.ts @@ -2088,7 +2088,7 @@ export namespace reseller_v1 { export interface Params$Resource$Subscriptions$Insert extends StandardParameters { /** - * The intented insert action. The usage of this field is governed by certain policies which are being developed & tested currently. Hence, these might not work as intended. Once this is fully tested & available to consume, we will share more information about its usage, limitations and policy documentation. + * The intented insert action. Advised to set this when the customer already has a subscription for a different SKU in the same product. */ action?: string; /** @@ -2100,7 +2100,7 @@ export namespace reseller_v1 { */ customerId?: string; /** - * The sku_id of the existing subscription to be upgraded or downgraded. This is required when action is SWITCH. The usage of this field is governed by certain policies which are being developed & tested currently. Hence, these might not work as intended. Once this is fully tested & available to consume, we will share more information about its usage, limitations and policy documentation. + * The sku_id of the existing subscription to be upgraded or downgraded. This is required when action is SWITCH. */ sourceSkuId?: string; diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index d4af074ca7..17648c9701 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -596,7 +596,11 @@ export namespace retail_v2 { */ export interface Schema$GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter { /** - * Merchant Center primary feed ID. + * AFM data source ID. + */ + dataSourceId?: string | null; + /** + * Merchant Center primary feed ID. Deprecated: use data_source_id instead. */ primaryFeedId?: string | null; /** @@ -1791,6 +1795,15 @@ export namespace retail_v2 { */ text?: string[] | null; } + /** + * A message with a list of double values. + */ + export interface Schema$GoogleCloudRetailV2DoubleList { + /** + * The list of double values. + */ + values?: number[] | null; + } /** * Metadata for active A/B testing experiment. */ @@ -2225,10 +2238,6 @@ export namespace retail_v2 { attributes?: { [key: string]: Schema$GoogleCloudRetailV2CustomAttribute; } | null; - /** - * Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details. - */ - availability?: string | null; /** * Optional. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned. */ @@ -3650,6 +3659,10 @@ export namespace retail_v2 { * If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" ColorInfo and the query. */ matchingVariantFields?: {[key: string]: string} | null; + /** + * Google provided available scores. + */ + modelScores?: {[key: string]: Schema$GoogleCloudRetailV2DoubleList} | null; /** * Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that this product has been purchased before. */ diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index 294ab54034..812ae13b03 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -1070,10 +1070,6 @@ export namespace retail_v2alpha { * The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here. */ refinedSearch?: Schema$GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch[]; - /** - * This field is deprecated. Please find the refinded_query from search response when using CONVERSATIONAL_FILTER_ONLY mode in ConversationalSearchResponse.refined_search instead. The rephrased query based on the user's query and the conversation history. It can be used to fetch the relevant search results. - */ - rephrasedQuery?: string | null; } /** * This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. @@ -1171,6 +1167,15 @@ export namespace retail_v2alpha { */ text?: string[] | null; } + /** + * A message with a list of double values. + */ + export interface Schema$GoogleCloudRetailV2alphaDoubleList { + /** + * The list of double values. + */ + values?: number[] | null; + } /** * Metadata related to the EnrollSolution method. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -1836,7 +1841,11 @@ export namespace retail_v2alpha { */ export interface Schema$GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter { /** - * Merchant Center primary feed ID. + * AFM data source ID. + */ + dataSourceId?: string | null; + /** + * Merchant Center primary feed ID. Deprecated: use data_source_id instead. */ primaryFeedId?: string | null; /** @@ -1849,7 +1858,11 @@ export namespace retail_v2alpha { */ export interface Schema$GoogleCloudRetailV2alphaMerchantCenterFeedFilter { /** - * Merchant Center primary feed ID. + * AFM data source ID. + */ + dataSourceId?: string | null; + /** + * Merchant Center primary feed ID. Deprecated: use data_source_id instead. */ primaryFeedId?: string | null; /** @@ -3371,6 +3384,12 @@ export namespace retail_v2alpha { * If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" ColorInfo and the query. */ matchingVariantFields?: {[key: string]: string} | null; + /** + * Google provided available scores. + */ + modelScores?: { + [key: string]: Schema$GoogleCloudRetailV2alphaDoubleList; + } | null; /** * Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that this product has been purchased before. */ diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 1d9c262f8c..87fd1b65d7 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -536,7 +536,11 @@ export namespace retail_v2beta { */ export interface Schema$GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter { /** - * Merchant Center primary feed ID. + * AFM data source ID. + */ + dataSourceId?: string | null; + /** + * Merchant Center primary feed ID. Deprecated: use data_source_id instead. */ primaryFeedId?: string | null; /** @@ -1468,6 +1472,15 @@ export namespace retail_v2beta { */ text?: string[] | null; } + /** + * A message with a list of double values. + */ + export interface Schema$GoogleCloudRetailV2betaDoubleList { + /** + * The list of double values. + */ + values?: number[] | null; + } /** * Metadata for active A/B testing experiment. */ @@ -1962,10 +1975,6 @@ export namespace retail_v2beta { attributes?: { [key: string]: Schema$GoogleCloudRetailV2betaCustomAttribute; } | null; - /** - * Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). This field is currently only used by the Recommendations API. For Search, please make use of fulfillment_types or custom attributes for similar behaviour. See [here]( https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods) for more details. - */ - availability?: string | null; /** * Optional. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned. */ @@ -1984,7 +1993,11 @@ export namespace retail_v2beta { */ export interface Schema$GoogleCloudRetailV2betaMerchantCenterFeedFilter { /** - * Merchant Center primary feed ID. + * AFM data source ID. + */ + dataSourceId?: string | null; + /** + * Merchant Center primary feed ID. Deprecated: use data_source_id instead. */ primaryFeedId?: string | null; /** @@ -3442,6 +3455,12 @@ export namespace retail_v2beta { * If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" ColorInfo and the query. */ matchingVariantFields?: {[key: string]: string} | null; + /** + * Google provided available scores. + */ + modelScores?: { + [key: string]: Schema$GoogleCloudRetailV2betaDoubleList; + } | null; /** * Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that this product has been purchased before. */ diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 4649eaccba..ff49858668 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -7058,6 +7058,7 @@ export namespace run_v1 { revisions: Resource$Projects$Locations$Revisions; routes: Resource$Projects$Locations$Routes; services: Resource$Projects$Locations$Services; + workerpools: Resource$Projects$Locations$Workerpools; constructor(context: APIRequestContext) { this.context = context; this.authorizeddomains = @@ -7075,6 +7076,9 @@ export namespace run_v1 { this.revisions = new Resource$Projects$Locations$Revisions(this.context); this.routes = new Resource$Projects$Locations$Routes(this.context); this.services = new Resource$Projects$Locations$Services(this.context); + this.workerpools = new Resource$Projects$Locations$Workerpools( + this.context + ); } /** @@ -10132,4 +10136,321 @@ export namespace run_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } + + export class Resource$Projects$Locations$Workerpools { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get the IAM Access Control policy currently in effect for the given worker pool. This result does not include any inherited policies. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workerpools$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Workerpools$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workerpools$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the IAM Access control policy for the specified worker pool. Overwrites any existing 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. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workerpools$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified worker pool. There are no permissions required for making this API call. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workerpools$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Workerpools$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workerpools$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workerpools$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Workerpools$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workerpools$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Workerpools$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$Workerpools$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Workerpools$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } } diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 23b2b68c7b..6078e56ba1 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -2097,18 +2097,6 @@ export namespace run_v2 { * Optional. The total number of instances in manual scaling mode. */ manualInstanceCount?: number | null; - /** - * Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages. - */ - maxInstanceCount?: number | null; - /** - * Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages. - */ - minInstanceCount?: number | null; - /** - * Optional. The scaling mode for the worker pool. - */ - scalingMode?: string | null; } /** * ApprovalConfig describes configuration for manual approval of a build. @@ -7649,6 +7637,100 @@ export namespace run_v2 { } } + /** + * Gets the IAM Access Control policy currently in effect for the given Cloud Run WorkerPool. This result does not include any inherited policies. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Workerpools$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Workerpools$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workerpools$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists WorkerPools. Results are sorted by creation time, descending. * @@ -7838,6 +7920,100 @@ export namespace run_v2 { } } + /** + * Sets the IAM Access control policy for the specified WorkerPool. Overwrites any existing 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. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Workerpools$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Workerpools$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Workerpools$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Workerpools$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. * @@ -7979,6 +8155,17 @@ export namespace run_v2 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Workerpools$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$Workerpools$List extends StandardParameters { /** @@ -8026,6 +8213,18 @@ export namespace run_v2 { */ requestBody?: Schema$GoogleCloudRunV2WorkerPool; } + export interface Params$Resource$Projects$Locations$Workerpools$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$Workerpools$Testiampermissions extends StandardParameters { /** diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 1dd3b66510..3e3e270aca 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -894,7 +894,7 @@ export namespace securitycenter_v1 { */ description?: string | null; /** - * The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed.. + * The end position of the error in the uploaded text version of the module. This field may be omitted if no specific position applies, or if one could not be computed. */ end?: Schema$Position; /** @@ -910,6 +910,9 @@ export namespace securitycenter_v1 { * A list of zero or more errors encountered while validating the uploaded configuration of an Event Threat Detection Custom Module. */ export interface Schema$CustomModuleValidationErrors { + /** + * The list of errors. + */ errors?: Schema$CustomModuleValidationError[]; } /** @@ -1326,6 +1329,10 @@ export namespace securitycenter_v1 { * The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. */ hashedSize?: string | null; + /** + * Operation(s) performed on a file. + */ + operations?: Schema$FileOperation[]; /** * True when the hash covers only a prefix of the file. */ @@ -1343,6 +1350,15 @@ export namespace securitycenter_v1 { */ size?: string | null; } + /** + * Operation(s) performed on a file. + */ + export interface Schema$FileOperation { + /** + * The type of the operation + */ + type?: string | null; + } /** * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. */ @@ -3195,6 +3211,10 @@ export namespace securitycenter_v1 { * The length in bytes of the file prefix that was hashed. If hashed_size == size, any hashes reported represent the entire file. */ hashedSize?: string | null; + /** + * Operation(s) performed on a file. + */ + operations?: Schema$GoogleCloudSecuritycenterV2FileOperation[]; /** * True when the hash covers only a prefix of the file. */ @@ -3212,6 +3232,15 @@ export namespace securitycenter_v1 { */ size?: string | null; } + /** + * Operation(s) performed on a file. + */ + export interface Schema$GoogleCloudSecuritycenterV2FileOperation { + /** + * The type of the operation + */ + type?: string | null; + } /** * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. */ @@ -5606,7 +5635,13 @@ export namespace securitycenter_v1 { * A position in the uploaded text version of a module. */ export interface Schema$Position { + /** + * The column number. + */ columnNumber?: number | null; + /** + * The line number. + */ lineNumber?: number | null; } /** diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 45cd48c5bc..455b0c1747 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -194,7 +194,7 @@ export namespace serviceconsumermanagement_v1 { */ kind?: string | null; /** - * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. */ spec?: {[key: string]: any} | null; } diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index 2a72d8d730..b4f9f21729 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -168,7 +168,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ kind?: string | null; /** - * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. */ spec?: {[key: string]: any} | null; } diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 98b6c6f074..ee1beeab6a 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -177,7 +177,7 @@ export namespace servicemanagement_v1 { */ kind?: string | null; /** - * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. */ spec?: {[key: string]: any} | null; } diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index deba0ed5fe..aa16fbf279 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -334,7 +334,7 @@ export namespace servicenetworking_v1 { */ kind?: string | null; /** - * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. */ spec?: {[key: string]: any} | null; } @@ -469,6 +469,73 @@ export namespace servicenetworking_v1 { */ selector?: string | null; } + /** + * `BatchingConfigProto` defines the batching configuration for an API method. + */ + export interface Schema$BatchingConfigProto { + /** + * The request and response fields used in batching. + */ + batchDescriptor?: Schema$BatchingDescriptorProto; + /** + * The thresholds which trigger a batched request to be sent. + */ + thresholds?: Schema$BatchingSettingsProto; + } + /** + * `BatchingDescriptorProto` specifies the fields of the request message to be used for batching, and, optionally, the fields of the response message to be used for demultiplexing. + */ + export interface Schema$BatchingDescriptorProto { + /** + * The repeated field in the request message to be aggregated by batching. + */ + batchedField?: string | null; + /** + * A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in `request_discriminator_fields` is equal between the two requests. + */ + discriminatorFields?: string[] | null; + /** + * Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together. + */ + subresponseField?: string | null; + } + /** + * `BatchingSettingsProto` specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero. + */ + export interface Schema$BatchingSettingsProto { + /** + * The duration after which a batch should be sent, starting from the addition of the first message to that batch. + */ + delayThreshold?: string | null; + /** + * The maximum number of elements collected in a batch that could be accepted by server. + */ + elementCountLimit?: number | null; + /** + * The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent. + */ + elementCountThreshold?: number | null; + /** + * The maximum size of data allowed by flow control. + */ + flowControlByteLimit?: number | null; + /** + * The maximum number of elements allowed by flow control. + */ + flowControlElementLimit?: number | null; + /** + * The behavior to take when the flow control limit is exceeded. + */ + flowControlLimitExceededBehavior?: string | null; + /** + * The maximum size of the request that could be accepted by server. + */ + requestByteLimit?: number | null; + /** + * The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message. + */ + requestByteThreshold?: string | null; + } /** * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count */ @@ -1452,6 +1519,10 @@ export namespace servicenetworking_v1 { * List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id */ autoPopulatedFields?: string[] | null; + /** + * Batching configuration for an API method in client libraries. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.BatchCreateExample batching: element_count_threshold: 1000 request_byte_threshold: 100000000 delay_threshold_millis: 10 + */ + batching?: Schema$BatchingConfigProto; /** * Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 minutes */ diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index f6985db0aa..035beee7de 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -239,7 +239,7 @@ export namespace servicenetworking_v1beta { */ kind?: string | null; /** - * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. */ spec?: {[key: string]: any} | null; } @@ -374,6 +374,73 @@ export namespace servicenetworking_v1beta { */ selector?: string | null; } + /** + * `BatchingConfigProto` defines the batching configuration for an API method. + */ + export interface Schema$BatchingConfigProto { + /** + * The request and response fields used in batching. + */ + batchDescriptor?: Schema$BatchingDescriptorProto; + /** + * The thresholds which trigger a batched request to be sent. + */ + thresholds?: Schema$BatchingSettingsProto; + } + /** + * `BatchingDescriptorProto` specifies the fields of the request message to be used for batching, and, optionally, the fields of the response message to be used for demultiplexing. + */ + export interface Schema$BatchingDescriptorProto { + /** + * The repeated field in the request message to be aggregated by batching. + */ + batchedField?: string | null; + /** + * A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in `request_discriminator_fields` is equal between the two requests. + */ + discriminatorFields?: string[] | null; + /** + * Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together. + */ + subresponseField?: string | null; + } + /** + * `BatchingSettingsProto` specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero. + */ + export interface Schema$BatchingSettingsProto { + /** + * The duration after which a batch should be sent, starting from the addition of the first message to that batch. + */ + delayThreshold?: string | null; + /** + * The maximum number of elements collected in a batch that could be accepted by server. + */ + elementCountLimit?: number | null; + /** + * The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent. + */ + elementCountThreshold?: number | null; + /** + * The maximum size of data allowed by flow control. + */ + flowControlByteLimit?: number | null; + /** + * The maximum number of elements allowed by flow control. + */ + flowControlElementLimit?: number | null; + /** + * The behavior to take when the flow control limit is exceeded. + */ + flowControlLimitExceededBehavior?: string | null; + /** + * The maximum size of the request that could be accepted by server. + */ + requestByteLimit?: number | null; + /** + * The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message. + */ + requestByteThreshold?: string | null; + } /** * Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count */ @@ -1247,6 +1314,10 @@ export namespace servicenetworking_v1beta { * List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id */ autoPopulatedFields?: string[] | null; + /** + * Batching configuration for an API method in client libraries. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.BatchCreateExample batching: element_count_threshold: 1000 request_byte_threshold: 100000000 delay_threshold_millis: 10 + */ + batching?: Schema$BatchingConfigProto; /** * Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: 60s # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90 minutes */ diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index bd8aaea6ad..8dcf550e96 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -261,7 +261,7 @@ export namespace serviceusage_v1 { */ kind?: string | null; /** - * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. */ spec?: {[key: string]: any} | null; } diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 3f3264e0a6..29c5f5e9c0 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -261,7 +261,7 @@ export namespace serviceusage_v1beta1 { */ kind?: string | null; /** - * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`. + * Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. */ spec?: {[key: string]: any} | null; } diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index e6a26d5a19..a145ea2672 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -312,6 +312,15 @@ export namespace sheets_v4 { */ table?: Schema$Table; } + /** + * The result of adding a table. + */ + export interface Schema$AddTableResponse { + /** + * Output only. The table that was added. + */ + table?: Schema$Table; + } /** * Adds new cells after the last row with data in a sheet, inserting new rows into the sheet if necessary. */ @@ -402,9 +411,13 @@ export namespace sheets_v4 { */ export interface Schema$BandedRange { /** - * The ID of the banded range. + * The ID of the banded range. If unset, refer to banded_range_reference. */ bandedRangeId?: number | null; + /** + * Output only. The reference of the banded range, used to identify the ID that is not supported by the banded_range_id. + */ + bandedRangeReference?: string | null; /** * Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of row_properties or column_properties must be specified. */ @@ -3833,6 +3846,10 @@ export namespace sheets_v4 { * A reply from adding a slicer. */ addSlicer?: Schema$AddSlicerResponse; + /** + * A reply from adding a table. + */ + addTable?: Schema$AddTableResponse; /** * A reply from cancelling data source object refreshes. */ diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index 0808859146..4c3c065d2c 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -583,7 +583,7 @@ export namespace sqladmin_v1 { */ connectionPoolingEnabled?: boolean | null; /** - * Optional. List of connection pool configuration flags + * Optional. List of connection pool configuration flags. */ flags?: Schema$ConnectionPoolFlags[]; } @@ -1402,7 +1402,7 @@ export namespace sqladmin_v1 { */ queryPlansPerMinute?: number | null; /** - * Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. + * Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. */ queryStringLength?: number | null; /** @@ -2132,7 +2132,7 @@ export namespace sqladmin_v1 { */ export interface Schema$PscAutoConnectionConfig { /** - * The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. + * Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. */ consumerNetwork?: string | null; /** @@ -2140,7 +2140,7 @@ export namespace sqladmin_v1 { */ consumerNetworkStatus?: string | null; /** - * This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + * Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. */ consumerProject?: string | null; /** @@ -2160,6 +2160,10 @@ export namespace sqladmin_v1 { * Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). */ allowedConsumerProjects?: string[] | null; + /** + * Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + */ + networkAttachmentUri?: string | null; /** * Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. */ @@ -3732,7 +3736,7 @@ export namespace sqladmin_v1 { } /** - * This API updates the following: 1- retention period and description of backup in case of final backups only. 2- gcbdr_soft_delete_status of backup in case of GCBDR managed backups only. + * Updates the retention period and description of the backup. You can use this API to update final backups only. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3869,7 +3873,7 @@ export namespace sqladmin_v1 { */ name?: string; /** - * The list of fields that you can update. 1- You can update only the description and retention period for a final backup. 2- You can update only the gcbdr_soft_delete_status for GCBDR managed backup. + * The list of fields that you can update. You can update only the description and retention period of the final backup. */ updateMask?: string; diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 59e8aa14af..2b4c6a4ced 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -583,7 +583,7 @@ export namespace sqladmin_v1beta4 { */ connectionPoolingEnabled?: boolean | null; /** - * Optional. List of connection pool configuration flags + * Optional. List of connection pool configuration flags. */ flags?: Schema$ConnectionPoolFlags[]; } @@ -1405,7 +1405,7 @@ export namespace sqladmin_v1beta4 { */ queryPlansPerMinute?: number | null; /** - * Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. + * Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. */ queryStringLength?: number | null; /** @@ -2135,7 +2135,7 @@ export namespace sqladmin_v1beta4 { */ export interface Schema$PscAutoConnectionConfig { /** - * The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. + * Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. */ consumerNetwork?: string | null; /** @@ -2143,7 +2143,7 @@ export namespace sqladmin_v1beta4 { */ consumerNetworkStatus?: string | null; /** - * This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + * Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. */ consumerProject?: string | null; /** @@ -2163,6 +2163,10 @@ export namespace sqladmin_v1beta4 { * Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). */ allowedConsumerProjects?: string[] | null; + /** + * Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + */ + networkAttachmentUri?: string | null; /** * Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. */ @@ -2397,7 +2401,7 @@ export namespace sqladmin_v1beta4 { */ pricingPlan?: string | null; /** - * Optional. Configuration value for recreation of replica after certain replication lag + * Optional. Configuration value for recreation of replica after certain replication lag. */ replicationLagMaxSeconds?: number | null; /** @@ -3737,7 +3741,7 @@ export namespace sqladmin_v1beta4 { } /** - * This API updates the following: 1- retention period and description of backup in case of final backups only. 2- gcbdr_soft_delete_status of backup in case of GCBDR managed backups only. + * Updates the retention period and the description of the backup. You can use this API to update final backups only. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3877,7 +3881,7 @@ export namespace sqladmin_v1beta4 { */ name?: string; /** - * The list of fields that you can update. 1- You can update only the description and retention period for a final backup. 2- You can update only the gcbdr_soft_delete_status for GCBDR managed backup. + * The list of fields that you can update. You can update only the description and retention period of the final backup. */ updateMask?: string; diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index 1bff981ba8..27da4a801d 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -240,6 +240,10 @@ export namespace storagetransfer_v1 { * Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" \} GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor` for the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If `credentials_secret` is specified, do not specify azure_credentials. Format: `projects/{project_number\}/secrets/{secret_name\}` */ credentialsSecret?: string | null; + /** + * Optional. Federated identity config of a user registered Azure application. If `federated_identity_config` is specified, do not specify azure_credentials or credentials_secret. + */ + federatedIdentityConfig?: Schema$FederatedIdentityConfig; /** * Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. */ @@ -339,6 +343,19 @@ export namespace storagetransfer_v1 { */ name?: string | null; } + /** + * Identities of a user registered Azure application that enables identity federation to trust tokens issued by the user's Google service account. For more information about Azure application and identity federation, see [Register an application with the Microsoft identity platform] (https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) Azure RBAC roles then need be assigned to the Azure application to authorize access to the user's Azure data source. For more information about Azure RBAC roles for blobs, see [Manage Access Rights with RBAC] (https://learn.microsoft.com/en-us/rest/api/storageservices/authorize-with-azure-active-directory#manage-access-rights-with-rbac) + */ + export interface Schema$FederatedIdentityConfig { + /** + * Required. Client (application) ID of the application with federated credentials. + */ + clientId?: string | null; + /** + * Required. Tenant (directory) ID of the application with federated credentials. + */ + tenantId?: string | null; + } /** * In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. */ @@ -383,7 +400,7 @@ export namespace storagetransfer_v1 { */ export interface Schema$HttpData { /** - * Required. The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. + * Required. The URL that points to the file that stores the object list entries. This file must allow public access. The URL is either an HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a Cloud Storage path (e.g. `gs://my-bucket/urllist.tsv`). */ listUrl?: string | null; } @@ -502,7 +519,7 @@ export namespace storagetransfer_v1 { pubsubTopic?: string | null; } /** - * Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage. The "last modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects, the `LastModified` field of S3 objects, and the `Last-Modified` header of Azure blobs. Transfers with a PosixFilesystem source or destination don't support `ObjectConditions`. + * Conditions that determine which objects are transferred. Applies only to Cloud Data Sources such as S3, Azure, and Cloud Storage. The "last modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects, the `LastModified` field of S3 objects, and the `Last-Modified` header of Azure blobs. For S3 objects, the `LastModified` value is the time the object begins uploading. If the object meets your "last modification time" criteria, but has not finished uploading, the object is not transferred. See [Transfer from Amazon S3 to Cloud Storage](https://cloud.google.com/storage-transfer/docs/create-transfers/agentless/s3#transfer_options) for more information. Transfers with a PosixFilesystem source or destination don't support `ObjectConditions`. */ export interface Schema$ObjectConditions { /** @@ -827,6 +844,10 @@ export namespace storagetransfer_v1 { * Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule. */ schedule?: Schema$Schedule; + /** + * Optional. The service account to be used to access resources in the consumer project in the transfer job. We accept `email` or `uniqueId` for the service account. Service account format is projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID\} See https://cloud.google.com/iam/docs/reference/credentials/rest/v1/projects.serviceAccounts/generateAccessToken#path-parameters for details. Caller requires the following IAM permission on the specified service account: `iam.serviceAccounts.actAs`. project-PROJECT_NUMBER@storage-transfer-service.iam.gserviceaccount.com requires the following IAM permission on the specified service account: `iam.serviceAccounts.getAccessToken` + */ + serviceAccount?: string | null; /** * Status of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation. */ diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index f0368f0e02..2b4e091b36 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -1679,7 +1679,7 @@ export namespace tasks_v1 { */ destinationTasklist?: string; /** - * Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned tasks can not be set as parent task (have subtasks) or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty. + * Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned and repeating tasks cannot be set as parent tasks (have subtasks), or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty. */ parent?: string; /** diff --git a/src/apis/texttospeech/v1.ts b/src/apis/texttospeech/v1.ts index dd03a26ec8..699022d54c 100644 --- a/src/apis/texttospeech/v1.ts +++ b/src/apis/texttospeech/v1.ts @@ -313,6 +313,10 @@ export namespace texttospeech_v1 { * Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag. */ customPronunciations?: Schema$CustomPronunciations; + /** + * Markup for HD voices specifically. This field may not be used with any other voices. + */ + markup?: string | null; /** * The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis. */ diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index 75037d6de3..a598a424f9 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -303,6 +303,10 @@ export namespace texttospeech_v1beta1 { * Optional. The pronunciation customizations are applied to the input. If this is set, the input is synthesized using the given pronunciation customizations. The initial support is for en-us, with plans to expand to other locales in the future. Instant Clone voices aren't supported. In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag. */ customPronunciations?: Schema$CustomPronunciations; + /** + * Markup for HD voices specifically. This field may not be used with any other voices. + */ + markup?: string | null; /** * The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis. */ diff --git a/src/apis/walletobjects/v1.ts b/src/apis/walletobjects/v1.ts index e441ca0bea..5dd3179d00 100644 --- a/src/apis/walletobjects/v1.ts +++ b/src/apis/walletobjects/v1.ts @@ -675,7 +675,7 @@ export namespace walletobjects_v1 { */ export interface Schema$DiscoverableProgramMerchantSignupInfo { /** - * User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program. + * User data that is sent in a POST request to the signup website URL. This information is encoded and then shared so that the merchant's website can prefill fields used to enroll the user for the discoverable program. */ signupSharedDatas?: string[] | null; /** diff --git a/src/index.ts b/src/index.ts index 781e949554..b9dc7586ad 100644 --- a/src/index.ts +++ b/src/index.ts @@ -67,6 +67,7 @@ export {androidpublisher_v3} from './apis/androidpublisher/v3'; export {apigateway_v1} from './apis/apigateway/v1'; export {apigateway_v1beta} from './apis/apigateway/v1beta'; export {apigeeregistry_v1} from './apis/apigeeregistry/v1'; +export {apihub_v1} from './apis/apihub/v1'; export {apikeys_v2} from './apis/apikeys/v2'; export {apim_v1alpha} from './apis/apim/v1alpha'; export {appengine_v1} from './apis/appengine/v1'; @@ -267,6 +268,8 @@ export {firebaseappcheck_v1} from './apis/firebaseappcheck/v1'; export {firebaseappcheck_v1beta} from './apis/firebaseappcheck/v1beta'; export {firebaseappdistribution_v1} from './apis/firebaseappdistribution/v1'; export {firebaseappdistribution_v1alpha} from './apis/firebaseappdistribution/v1alpha'; +export {firebaseapphosting_v1} from './apis/firebaseapphosting/v1'; +export {firebaseapphosting_v1beta} from './apis/firebaseapphosting/v1beta'; export {firebasedatabase_v1beta} from './apis/firebasedatabase/v1beta'; export {firebasedataconnect_v1} from './apis/firebasedataconnect/v1'; export {firebasedataconnect_v1beta} from './apis/firebasedataconnect/v1beta'; @@ -352,8 +355,10 @@ export {merchantapi_accounts_v1beta} from './apis/merchantapi/accounts_v1beta'; export {merchantapi_conversions_v1beta} from './apis/merchantapi/conversions_v1beta'; export {merchantapi_datasources_v1beta} from './apis/merchantapi/datasources_v1beta'; export {merchantapi_inventories_v1beta} from './apis/merchantapi/inventories_v1beta'; +export {merchantapi_issueresolution_v1beta} from './apis/merchantapi/issueresolution_v1beta'; export {merchantapi_lfp_v1beta} from './apis/merchantapi/lfp_v1beta'; export {merchantapi_notifications_v1beta} from './apis/merchantapi/notifications_v1beta'; +export {merchantapi_ordertracking_v1beta} from './apis/merchantapi/ordertracking_v1beta'; export {merchantapi_products_v1beta} from './apis/merchantapi/products_v1beta'; export {merchantapi_promotions_v1beta} from './apis/merchantapi/promotions_v1beta'; export {merchantapi_quota_v1beta} from './apis/merchantapi/quota_v1beta';