diff --git a/discovery/accesscontextmanager-v1.json b/discovery/accesscontextmanager-v1.json index aacba9f8c64..05f3e8973e5 100644 --- a/discovery/accesscontextmanager-v1.json +++ b/discovery/accesscontextmanager-v1.json @@ -809,6 +809,21 @@ "name" ], "parameters": { + "deletedPrincipalSyntax": { + "description": "Optional. If true, the response will contain the deleted principal syntax for identities that support it.", + "enum": [ + "DELETED_PRINCIPAL_SYNTAX_SUPPORT_UNSPECIFIED", + "DELETED_PRINCIPAL_SYNTAX_SUPPORT_DISABLED", + "DELETED_PRINCIPAL_SYNTAX_SUPPORT_ENABLED" + ], + "enumDescriptions": [ + "Deleted principal syntax support was not specified.", + "Deleted principal syntax is disabled and no identities in the request or response will contain deleted principal syntax.", + "The request and response can contain identities with deleted IAM principal syntax." + ], + "location": "query", + "type": "string" + }, "name": { "description": "Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}`", "location": "path", @@ -834,6 +849,21 @@ "parent" ], "parameters": { + "deletedPrincipalSyntax": { + "description": "Optional. If true, the response will contain the deleted principal syntax for identities that support it.", + "enum": [ + "DELETED_PRINCIPAL_SYNTAX_SUPPORT_UNSPECIFIED", + "DELETED_PRINCIPAL_SYNTAX_SUPPORT_DISABLED", + "DELETED_PRINCIPAL_SYNTAX_SUPPORT_ENABLED" + ], + "enumDescriptions": [ + "Deleted principal syntax support was not specified.", + "Deleted principal syntax is disabled and no identities in the request or response will contain deleted principal syntax.", + "The request and response can contain identities with deleted IAM principal syntax." + ], + "location": "query", + "type": "string" + }, "pageSize": { "description": "Number of Service Perimeters to include in the list. Default 100.", "format": "int32", @@ -870,6 +900,21 @@ "name" ], "parameters": { + "deletedPrincipalSyntax": { + "description": "Optional. If true, the response will contain the deleted principal syntax for identities that support it and the request can contain identities with deleted principal syntax.", + "enum": [ + "DELETED_PRINCIPAL_SYNTAX_SUPPORT_UNSPECIFIED", + "DELETED_PRINCIPAL_SYNTAX_SUPPORT_DISABLED", + "DELETED_PRINCIPAL_SYNTAX_SUPPORT_ENABLED" + ], + "enumDescriptions": [ + "Deleted principal syntax support was not specified.", + "Deleted principal syntax is disabled and no identities in the request or response will contain deleted principal syntax.", + "The request and response can contain identities with deleted IAM principal syntax." + ], + "location": "query", + "type": "string" + }, "name": { "description": "Identifier. Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `name`.", "location": "path", @@ -1336,7 +1381,7 @@ } } }, - "revision": "20260809", + "revision": "20260819", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1650,7 +1695,7 @@ }, "restrictedProject": { "$ref": "Project", - "description": "Optional. The GCP project that is subject to this binding's scope." + "description": "Optional. The Google Cloud project that is subject to this binding's scope." } }, "type": "object" @@ -2427,7 +2472,7 @@ "id": "Principal", "properties": { "federatedPrincipal": { - "description": "Immutable. IAM federated principal name to assign policies to workforce/workload federated identities. Can be principal set or single principal, here are some examples: Single principal: principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value} PrincipalSet: principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*", + "description": "Immutable. The IAM principal identifier of the federated workforce or workload to assign the policy to. Examples include the following: * Single principal: `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}` * All workloads in a workload identity pool: `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*` * All Workforce Pools in a Google Cloud organization: `principalSet://cloudresourcemanager.googleapis.com/organizations/{organization_id}/type/WorkforcePool` Bindings created for all Workforce Pools in a Google Cloud organization support only `scoped_access_settings` with the `restricted_project` client scope and active `session_settings`. No other configurations are allowed.", "type": "string" }, "serviceAccount": { @@ -2453,11 +2498,11 @@ "type": "object" }, "Project": { - "description": "A GCP project which contains applications and resources that users can access.", + "description": "A Google Cloud project which contains applications and resources that users can access.", "id": "Project", "properties": { "name": { - "description": "The GCP project resource name. Format: \"projects/{project_number}\" (Only the numeric project name variation is supported). Example: \"projects/1234567890\"", + "description": "The Google Cloud project resource name. Format: `projects/{project_number}`. Only the project number is supported. Example: `projects/1234567890`", "type": "string" } }, @@ -2671,7 +2716,7 @@ "type": "string" }, "sessionLength": { - "description": "Optional. The session length. Setting this field to zero allows for sessions that are active indefinitely. Also, setting `session_length_enabled` to false disregards session limits, which means that sessions never expire. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and the OIDC max_age param. If this field is set to zero, `session_length_enabled` must be set to false or left unset.", + "description": "Optional. The session length. Setting this field to zero allows for sessions that are active indefinitely. Also, setting `session_length_enabled` to `false` disregards session limits, which means that sessions never expire. If `use_oidc_max_age` is `true`, for OIDC apps, the session length will be the minimum of this field and the OIDC `max_age` param. If this field is set to zero, `session_length_enabled` must be set to `false` or left unset.", "format": "google-duration", "type": "string" }, diff --git a/discovery/agentidentitycredentials-v1.json b/discovery/agentidentitycredentials-v1.json index 52217ca57af..74bec52079a 100644 --- a/discovery/agentidentitycredentials-v1.json +++ b/discovery/agentidentitycredentials-v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://agentidentitycredentials.googleapis.com/", "batchPath": "batch", "canonicalName": "Agent Identity Credentials", - "description": "agentidentitycredentials.googleapis.com API.", + "description": "The Agent Identity Credentials API retrieves and finalizes authorization credentials for auth providers.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/docs/", "fullyEncodeReservedExpansion": true, @@ -123,7 +123,7 @@ ], "parameters": { "authProvider": { - "description": "Required. The resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", + "description": "Required. The resource name of the auth provider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "required": true, @@ -142,7 +142,7 @@ ] }, "retrieve": { - "description": "Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.", + "description": "Retrieves authorization credentials for an auth provider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `result` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/credentials:retrieve", "httpMethod": "POST", "id": "agentidentitycredentials.projects.locations.authProviders.credentials.retrieve", @@ -151,7 +151,7 @@ ], "parameters": { "authProvider": { - "description": "Required. The parent resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", + "description": "Required. The resource name of the auth provider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "required": true, @@ -178,21 +178,21 @@ } } }, - "revision": "20260717", + "revision": "20260813", "rootUrl": "https://agentidentitycredentials.googleapis.com/", "schemas": { "GoogleCloudAgentidentitycredentialsV1_ConsentRejected": { - "description": "Indicates the user has rejected the permission delegation or cancelled the request.", + "description": "Indicates the user has rejected the permission delegation or canceled the request.", "id": "GoogleCloudAgentidentitycredentialsV1_ConsentRejected", "properties": {}, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsRequest": { - "description": "Request message for FinalizeCredentials.", + "description": "Request message for `FinalizeCredentials`.", "id": "GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsRequest", "properties": { "consentNonce": { - "description": "Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata.", + "description": "Required. The same `consent_nonce` value that was provided during retrieval in the [UriConsentRequired](https://cloud.google.com/iam/docs/reference/agentidentitycredentials/rest/v1/projects.locations.authProviders.credentials/retrieve#UriConsentRequired) metadata.", "type": "string" }, "userId": { @@ -208,27 +208,27 @@ "type": "object" }, "GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsResponse": { - "description": "Response message for FinalizeCredentials. Intentionally empty", + "description": "Response message for `FinalizeCredentials`. Intentionally empty.", "id": "GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsResponse", "properties": {}, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1_Pending": { - "description": "Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time.", + "description": "Indicates that the credential retrieval is pending. The caller should retry the `RetrieveCredentials` request after some time.", "id": "GoogleCloudAgentidentitycredentialsV1_Pending", "properties": {}, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsRequest": { - "description": "Request message for RetrieveCredentials.", + "description": "Request message for `RetrieveCredentials`.", "id": "GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsRequest", "properties": { "continueUri": { - "description": "Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected.", + "description": "Optional. The URI to redirect the user to after consent is completed. This field is required for auth providers using the 3-legged OAuth flow. For other auth provider types, this field is unused but not rejected.", "type": "string" }, "forceRefreshToken": { - "description": "Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow.", + "description": "Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Setting this field triggers a refresh of the access token with a stored refresh token, if possible, or a new consent flow.", "type": "string" }, "scopes": { @@ -246,7 +246,7 @@ "type": "object" }, "GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsResponse": { - "description": "Response message for RetrieveCredentials. Contains the access tokens and related artifacts.", + "description": "Response message for `RetrieveCredentials`. Contains the access tokens and related artifacts.", "id": "GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsResponse", "properties": { "consentRejected": { @@ -263,7 +263,7 @@ }, "uriConsentRequired": { "$ref": "GoogleCloudAgentidentitycredentialsV1_UriConsentRequired", - "description": "Message indicating uri based consent is required." + "description": "Message indicating URI-based consent is required." } }, "type": "object" @@ -289,14 +289,14 @@ "type": "array" }, "token": { - "description": "The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.", + "description": "The retrieved access token or credential for the end user. On an MCP tool call, for an invalid token the OAuth spec states that this should return `401` or `403`, but MCP servers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to `RetrieveCredentials` with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.", "type": "string" } }, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1_UriConsentRequired": { - "description": "Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback", + "description": "Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback.", "id": "GoogleCloudAgentidentitycredentialsV1_UriConsentRequired", "properties": { "authorizationUri": { @@ -305,7 +305,7 @@ "type": "string" }, "consentNonce": { - "description": "Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5", + "description": "Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the `FinalizeCredentials` request to complete the OAuth exchange. This will always be present. Implemented per [RFC 6819 Section 5.3.5](https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5).", "readOnly": true, "type": "string" }, diff --git a/discovery/agentidentitycredentials-v1alpha.json b/discovery/agentidentitycredentials-v1alpha.json index 5567e037955..ed75eb9e164 100644 --- a/discovery/agentidentitycredentials-v1alpha.json +++ b/discovery/agentidentitycredentials-v1alpha.json @@ -12,7 +12,7 @@ "baseUrl": "https://agentidentitycredentials.googleapis.com/", "batchPath": "batch", "canonicalName": "Agent Identity Credentials", - "description": "agentidentitycredentials.googleapis.com API.", + "description": "The Agent Identity Credentials API retrieves and finalizes authorization credentials for auth providers.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/docs/", "fullyEncodeReservedExpansion": true, @@ -123,7 +123,7 @@ ], "parameters": { "authProvider": { - "description": "Required. The resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", + "description": "Required. The resource name of the auth provider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "required": true, @@ -142,7 +142,7 @@ ] }, "retrieve": { - "description": "Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.", + "description": "Retrieves authorization credentials for an auth provider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `result` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/credentials:retrieve", "httpMethod": "POST", "id": "agentidentitycredentials.projects.locations.authProviders.credentials.retrieve", @@ -151,7 +151,7 @@ ], "parameters": { "authProvider": { - "description": "Required. The parent resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", + "description": "Required. The resource name of the auth provider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "required": true, @@ -178,21 +178,21 @@ } } }, - "revision": "20260717", + "revision": "20260813", "rootUrl": "https://agentidentitycredentials.googleapis.com/", "schemas": { "GoogleCloudAgentidentitycredentialsV1alpha_ConsentRejected": { - "description": "Indicates the user has rejected the permission delegation or cancelled the request.", + "description": "Indicates the user has rejected the permission delegation or canceled the request.", "id": "GoogleCloudAgentidentitycredentialsV1alpha_ConsentRejected", "properties": {}, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsRequest": { - "description": "Request message for FinalizeCredentials.", + "description": "Request message for `FinalizeCredentials`.", "id": "GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsRequest", "properties": { "consentNonce": { - "description": "Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata.", + "description": "Required. The same `consent_nonce` value that was provided during retrieval in the [UriConsentRequired](https://cloud.google.com/iam/docs/reference/agentidentitycredentials/rest/v1/projects.locations.authProviders.credentials/retrieve#UriConsentRequired) metadata.", "type": "string" }, "userId": { @@ -208,27 +208,27 @@ "type": "object" }, "GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsResponse": { - "description": "Response message for FinalizeCredentials. Intentionally empty", + "description": "Response message for `FinalizeCredentials`. Intentionally empty.", "id": "GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsResponse", "properties": {}, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1alpha_Pending": { - "description": "Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time.", + "description": "Indicates that the credential retrieval is pending. The caller should retry the `RetrieveCredentials` request after some time.", "id": "GoogleCloudAgentidentitycredentialsV1alpha_Pending", "properties": {}, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsRequest": { - "description": "Request message for RetrieveCredentials.", + "description": "Request message for `RetrieveCredentials`.", "id": "GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsRequest", "properties": { "continueUri": { - "description": "Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected.", + "description": "Optional. The URI to redirect the user to after consent is completed. This field is required for auth providers using the 3-legged OAuth flow. For other auth provider types, this field is unused but not rejected.", "type": "string" }, "forceRefreshToken": { - "description": "Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow.", + "description": "Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Setting this field triggers a refresh of the access token with a stored refresh token, if possible, or a new consent flow.", "type": "string" }, "scopes": { @@ -246,7 +246,7 @@ "type": "object" }, "GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsResponse": { - "description": "Response message for RetrieveCredentials. Contains the access tokens and related artifacts.", + "description": "Response message for `RetrieveCredentials`. Contains the access tokens and related artifacts.", "id": "GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsResponse", "properties": { "consentRejected": { @@ -263,7 +263,7 @@ }, "uriConsentRequired": { "$ref": "GoogleCloudAgentidentitycredentialsV1alpha_UriConsentRequired", - "description": "Message indicating uri based consent is required." + "description": "Message indicating URI-based consent is required." } }, "type": "object" @@ -289,14 +289,14 @@ "type": "array" }, "token": { - "description": "The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.", + "description": "The retrieved access token or credential for the end user. On an MCP tool call, for an invalid token the OAuth spec states that this should return `401` or `403`, but MCP servers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to `RetrieveCredentials` with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.", "type": "string" } }, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1alpha_UriConsentRequired": { - "description": "Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback", + "description": "Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback.", "id": "GoogleCloudAgentidentitycredentialsV1alpha_UriConsentRequired", "properties": { "authorizationUri": { @@ -305,7 +305,7 @@ "type": "string" }, "consentNonce": { - "description": "Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5", + "description": "Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the `FinalizeCredentials` request to complete the OAuth exchange. This will always be present. Implemented per [RFC 6819 Section 5.3.5](https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5).", "readOnly": true, "type": "string" }, diff --git a/discovery/agentidentitycredentials-v1beta.json b/discovery/agentidentitycredentials-v1beta.json index ea75644d662..76dd3f8d567 100644 --- a/discovery/agentidentitycredentials-v1beta.json +++ b/discovery/agentidentitycredentials-v1beta.json @@ -12,7 +12,7 @@ "baseUrl": "https://agentidentitycredentials.googleapis.com/", "batchPath": "batch", "canonicalName": "Agent Identity Credentials", - "description": "agentidentitycredentials.googleapis.com API.", + "description": "The Agent Identity Credentials API retrieves and finalizes authorization credentials for auth providers.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/docs/", "fullyEncodeReservedExpansion": true, @@ -123,7 +123,7 @@ ], "parameters": { "authProvider": { - "description": "Required. The resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", + "description": "Required. The resource name of the auth provider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "required": true, @@ -142,7 +142,7 @@ ] }, "retrieve": { - "description": "Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.", + "description": "Retrieves authorization credentials for an auth provider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `result` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/credentials:retrieve", "httpMethod": "POST", "id": "agentidentitycredentials.projects.locations.authProviders.credentials.retrieve", @@ -151,7 +151,7 @@ ], "parameters": { "authProvider": { - "description": "Required. The parent resource name of the AuthProvider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", + "description": "Required. The resource name of the auth provider. Format: `projects/{project}/locations/{location}/authProviders/{auth_provider}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", "required": true, @@ -178,21 +178,21 @@ } } }, - "revision": "20260717", + "revision": "20260813", "rootUrl": "https://agentidentitycredentials.googleapis.com/", "schemas": { "GoogleCloudAgentidentitycredentialsV1beta_ConsentRejected": { - "description": "Indicates the user has rejected the permission delegation or cancelled the request.", + "description": "Indicates the user has rejected the permission delegation or canceled the request.", "id": "GoogleCloudAgentidentitycredentialsV1beta_ConsentRejected", "properties": {}, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsRequest": { - "description": "Request message for FinalizeCredentials.", + "description": "Request message for `FinalizeCredentials`.", "id": "GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsRequest", "properties": { "consentNonce": { - "description": "Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata.", + "description": "Required. The same `consent_nonce` value that was provided during retrieval in the [UriConsentRequired](https://cloud.google.com/iam/docs/reference/agentidentitycredentials/rest/v1/projects.locations.authProviders.credentials/retrieve#UriConsentRequired) metadata.", "type": "string" }, "userId": { @@ -208,27 +208,27 @@ "type": "object" }, "GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsResponse": { - "description": "Response message for FinalizeCredentials. Intentionally empty", + "description": "Response message for `FinalizeCredentials`. Intentionally empty.", "id": "GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsResponse", "properties": {}, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1beta_Pending": { - "description": "Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time.", + "description": "Indicates that the credential retrieval is pending. The caller should retry the `RetrieveCredentials` request after some time.", "id": "GoogleCloudAgentidentitycredentialsV1beta_Pending", "properties": {}, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsRequest": { - "description": "Request message for RetrieveCredentials.", + "description": "Request message for `RetrieveCredentials`.", "id": "GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsRequest", "properties": { "continueUri": { - "description": "Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected.", + "description": "Optional. The URI to redirect the user to after consent is completed. This field is required for auth providers using the 3-legged OAuth flow. For other auth provider types, this field is unused but not rejected.", "type": "string" }, "forceRefreshToken": { - "description": "Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow.", + "description": "Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Setting this field triggers a refresh of the access token with a stored refresh token, if possible, or a new consent flow.", "type": "string" }, "scopes": { @@ -246,7 +246,7 @@ "type": "object" }, "GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsResponse": { - "description": "Response message for RetrieveCredentials. Contains the access tokens and related artifacts.", + "description": "Response message for `RetrieveCredentials`. Contains the access tokens and related artifacts.", "id": "GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsResponse", "properties": { "consentRejected": { @@ -263,7 +263,7 @@ }, "uriConsentRequired": { "$ref": "GoogleCloudAgentidentitycredentialsV1beta_UriConsentRequired", - "description": "Message indicating uri based consent is required." + "description": "Message indicating URI-based consent is required." } }, "type": "object" @@ -289,14 +289,14 @@ "type": "array" }, "token": { - "description": "The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.", + "description": "The retrieved access token or credential for the end user. On an MCP tool call, for an invalid token the OAuth spec states that this should return `401` or `403`, but MCP servers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to `RetrieveCredentials` with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow.", "type": "string" } }, "type": "object" }, "GoogleCloudAgentidentitycredentialsV1beta_UriConsentRequired": { - "description": "Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback", + "description": "Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback.", "id": "GoogleCloudAgentidentitycredentialsV1beta_UriConsentRequired", "properties": { "authorizationUri": { @@ -305,7 +305,7 @@ "type": "string" }, "consentNonce": { - "description": "Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5", + "description": "Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the `FinalizeCredentials` request to complete the OAuth exchange. This will always be present. Implemented per [RFC 6819 Section 5.3.5](https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5).", "readOnly": true, "type": "string" }, diff --git a/discovery/agentregistry-v1alpha.json b/discovery/agentregistry-v1alpha.json index dae005d4c6c..f25db3f6ef5 100644 --- a/discovery/agentregistry-v1alpha.json +++ b/discovery/agentregistry-v1alpha.json @@ -1161,7 +1161,7 @@ "type": "string" }, "skillId": { - "description": "Required. Custom, user-defined unique container identifier. Must be unique within the parent project and location. This value should be 4-63 characters, and valid characters are `/a-z-/`.", + "description": "Required. Custom, user-defined unique container identifier. Must be unique within the parent project and location. This value should be 4-64 characters, and valid characters are `/a-z-/`.", "location": "query", "type": "string" } @@ -1244,7 +1244,9 @@ "https://www.googleapis.com/auth/agentregistry.read-write", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + ], + "supportsMediaDownload": true, + "useMediaDownloadService": true }, "list": { "description": "Lists logical Skills available in a project.", @@ -1557,7 +1559,7 @@ } } }, - "revision": "20260722", + "revision": "20260812", "rootUrl": "https://agentregistry.googleapis.com/", "schemas": { "A2ASkill": { diff --git a/discovery/alertcenter-v1beta1.json b/discovery/alertcenter-v1beta1.json index 0b4889ca6a6..3763754094c 100644 --- a/discovery/alertcenter-v1beta1.json +++ b/discovery/alertcenter-v1beta1.json @@ -423,7 +423,7 @@ } } }, - "revision": "20260810", + "revision": "20260817", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AbuseDetected": { @@ -1951,6 +1951,8 @@ "CHROME_WATERMARK", "CHROME_FORCE_SAVE_TO_CLOUD", "CHROME_KEEP_IN_MANAGED_CHROME", + "CHROME_BLOCK_DATA_COPIED", + "CHROME_WARN_DATA_COPIED", "DELETE_WEBPROTECT_EVIDENCE", "CHAT_BLOCK_CONTENT", "CHAT_WARN_USER", @@ -1986,6 +1988,8 @@ "Send watermark alert", "Force save to cloud storage.", "Keep in managed Chrome.", + "Block text copied from Chrome.", + "Warn on text copied from Chrome.", "Delete web protect evidence file", "Chat actions. Block Chat content to be sent out.", "Warn end user about Chat content.", @@ -2071,6 +2075,8 @@ "CHROME_WATERMARK", "CHROME_FORCE_SAVE_TO_CLOUD", "CHROME_KEEP_IN_MANAGED_CHROME", + "CHROME_BLOCK_DATA_COPIED", + "CHROME_WARN_DATA_COPIED", "DELETE_WEBPROTECT_EVIDENCE", "CHAT_BLOCK_CONTENT", "CHAT_WARN_USER", @@ -2106,6 +2112,8 @@ "Send watermark alert", "Force save to cloud storage.", "Keep in managed Chrome.", + "Block text copied from Chrome.", + "Warn on text copied from Chrome.", "Delete web protect evidence file", "Chat actions. Block Chat content to be sent out.", "Warn end user about Chat content.", diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index d5df43f185a..261dd24be0e 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -1879,7 +1879,7 @@ } } }, - "revision": "20260730", + "revision": "20260813", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AlloydbClhErrorsAlloyDbInternalDebugInfo": { @@ -1887,6 +1887,7 @@ "id": "AlloydbClhErrorsAlloyDbInternalDebugInfo", "properties": { "originalError": { + "description": "The original error message or details before sanitization, used internally for debugging and logging.", "type": "string" } }, diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index 549291c3b3f..7fa62862d5e 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -2086,7 +2086,7 @@ } } }, - "revision": "20260730", + "revision": "20260813", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AlloydbClhErrorsAlloyDbInternalDebugInfo": { @@ -2094,6 +2094,7 @@ "id": "AlloydbClhErrorsAlloyDbInternalDebugInfo", "properties": { "originalError": { + "description": "The original error message or details before sanitization, used internally for debugging and logging.", "type": "string" } }, diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 2e1f39b55e5..79bbbe2ef2a 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -2083,7 +2083,7 @@ } } }, - "revision": "20260730", + "revision": "20260813", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AlloydbClhErrorsAlloyDbInternalDebugInfo": { @@ -2091,6 +2091,7 @@ "id": "AlloydbClhErrorsAlloyDbInternalDebugInfo", "properties": { "originalError": { + "description": "The original error message or details before sanitization, used internally for debugging and logging.", "type": "string" } }, diff --git a/discovery/androiddeviceprovisioning-v1.json b/discovery/androiddeviceprovisioning-v1.json index 2f399011236..9001e9e1513 100644 --- a/discovery/androiddeviceprovisioning-v1.json +++ b/discovery/androiddeviceprovisioning-v1.json @@ -851,7 +851,7 @@ } } }, - "revision": "20260803", + "revision": "20260819", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { @@ -979,7 +979,8 @@ "type": "array" }, "skipWelcomeEmail": { - "description": "Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer.", + "deprecated": true, + "description": "Input only. Deprecated: This field is no longer supported and is ignored by the server.", "type": "boolean" }, "termsStatus": { @@ -1282,7 +1283,7 @@ ], "enumDescriptions": [ "Device type is not specified.", - "Android device", + "Android mobile and Desktop except Googlebooks and Chromebooks", "Chrome OS device" ], "type": "string" diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index e3f49ba5bc7..d52ef4de25e 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -1265,7 +1265,7 @@ } } }, - "revision": "20260810", + "revision": "20260820", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2087,11 +2087,13 @@ "description": "Optional. Whether the app is allowed to act as a credential provider on Android 14 and above.", "enum": [ "CREDENTIAL_PROVIDER_POLICY_UNSPECIFIED", - "CREDENTIAL_PROVIDER_ALLOWED" + "CREDENTIAL_PROVIDER_ALLOWED", + "CREDENTIAL_PROVIDER_DISALLOWED" ], "enumDescriptions": [ "Unspecified. The behaviour is governed by credentialProviderPolicyDefault.", - "App is allowed to act as a credential provider." + "App is allowed to act as a credential provider.", + "App is not allowed to act as a credential provider." ], "type": "string" }, @@ -6273,12 +6275,14 @@ "enum": [ "CREDENTIAL_PROVIDER_POLICY_DEFAULT_UNSPECIFIED", "CREDENTIAL_PROVIDER_DEFAULT_DISALLOWED", - "CREDENTIAL_PROVIDER_DEFAULT_DISALLOWED_EXCEPT_SYSTEM" + "CREDENTIAL_PROVIDER_DEFAULT_DISALLOWED_EXCEPT_SYSTEM", + "CREDENTIAL_PROVIDER_DEFAULT_ALLOWED" ], "enumDescriptions": [ "Unspecified. Defaults to CREDENTIAL_PROVIDER_DEFAULT_DISALLOWED.", "Apps with credentialProviderPolicy unspecified are not allowed to act as a credential provider.", - "Apps with credentialProviderPolicy unspecified are not allowed to act as a credential provider except for the OEM default credential providers. OEM default credential providers are always allowed to act as credential providers." + "Apps with credentialProviderPolicy unspecified are not allowed to act as a credential provider except for the OEM default credential providers. OEM default credential providers are always allowed to act as credential providers.", + "Apps with credentialProviderPolicy unspecified are allowed to act as a credential provider." ], "type": "string" }, diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 2c23a4242cc..f7defc07ab5 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -439,6 +439,64 @@ } } }, + "appsigning": { + "methods": { + "enrollApp": { + "description": "Enrolls an app in Play App Signing using a self-hosted Google Cloud KMS key. Warning: Do not use this method for standard Play App Signing enrollment. * Standard enrollment with Google-generated or Google-managed keys cannot be done via API. * This advanced API is strictly for enterprise organizations with mandatory compliance, regulatory, or policy requirements to retain key custody in an external Google Cloud KMS instance. * Prerequisites: Requires an active, properly configured Google Cloud KMS key with appropriate IAM permissions granted to Google Play before calling this method. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756", + "flatPath": "androidpublisher/v3/applications/{name}/appSigning:enrollApp", + "httpMethod": "POST", + "id": "androidpublisher.appsigning.enrollApp", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Either package name or app ID of the app enrolling in Play Signing.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "androidpublisher/v3/applications/{name}/appSigning:enrollApp", + "request": { + "$ref": "EnrollAppRequest" + }, + "response": { + "$ref": "EnrollAppResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidpublisher" + ] + }, + "rotateAppSigningKey": { + "description": "Rotates an app's signing key to a new self-hosted Google Cloud KMS key. Warning: This method only applies to apps enrolled with self-hosted Cloud KMS keys. For apps using standard Google-managed Play App Signing, key rotation requests must be initiated through the Google Play Console UI. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756", + "flatPath": "androidpublisher/v3/applications/{name}/appSigning:rotateAppSigningKey", + "httpMethod": "POST", + "id": "androidpublisher.appsigning.rotateAppSigningKey", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Either package name or app ID of the app rotating the signing key.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "androidpublisher/v3/applications/{name}/appSigning:rotateAppSigningKey", + "request": { + "$ref": "RotateAppSigningKeyRequest" + }, + "response": { + "$ref": "RotateAppSigningKeyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidpublisher" + ] + } + } + }, "appstoreappsreview": { "methods": { "createappstorehostedapp": { @@ -5912,7 +5970,7 @@ } } }, - "revision": "20260723", + "revision": "20260817", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -7577,6 +7635,52 @@ }, "type": "object" }, + "CertificateHashes": { + "description": "Hash digests of a certificate.", + "id": "CertificateHashes", + "properties": { + "certificateHashMd5": { + "description": "Hex-encoded MD5 hash of the certificate. example: `43:51:43:A1:B5:FC:8B:B7:0A:3A:A9:B1:0F:66:73:A8`", + "type": "string" + }, + "certificateHashSha1": { + "description": "Hex-encoded SHA1 hash of the certificate. example: `86:61:97:1A:D5:EF:E5:74:1E:A7:5B:84:7C:68:37:65:CD:94:16:DE`", + "type": "string" + }, + "certificateHashSha256": { + "description": "Hex-encoded SHA256 hash of the certificate. example: `94:49:C7:F3:A9:3C:F0:C5:5A:67:5D:DF:1C:83:73:2D:87:D5:62:55:E7:0B:15:0D:9E:6F:3C:F8:63:BB:7F:C1`", + "type": "string" + } + }, + "type": "object" + }, + "CloudKmsKey": { + "description": "Reference to a private key hosted in developer-managed Google Cloud KMS.", + "id": "CloudKmsKey", + "properties": { + "cryptoKeyVersionResource": { + "description": "Required. Resource identifier of the private key hosted in Google Cloud KMS. The Google Play service account must be granted Decrypt and Sign permissions on this resource. Format: projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/", + "type": "string" + } + }, + "type": "object" + }, + "CloudKmsKeyAndCert": { + "description": "Cloud KMS key and the certificate associated with the key.", + "id": "CloudKmsKeyAndCert", + "properties": { + "cloudKmsKey": { + "$ref": "CloudKmsKey", + "description": "Required. Cloud KMS key." + }, + "pemCertificate": { + "description": "Required. Certificate associated with the key. The bytes must contain the certificate in PEM format.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "CoarseLocation": { "description": "Coarse Geographic location details for where the consumption happened.", "id": "CoarseLocation", @@ -8634,6 +8738,63 @@ }, "type": "object" }, + "EnrollAppRequest": { + "description": "Request to enroll an app into Play App Signing using a self-hosted Cloud KMS key.", + "id": "EnrollAppRequest", + "properties": { + "enrollExistingApp": { + "$ref": "EnrollExistingApp", + "description": "Enrolls an existing app into Play signing using an external Cloud KMS key." + }, + "enrollNewApp": { + "$ref": "EnrollNewApp", + "description": "Changes the signing key of a new app to an external Cloud KMS key. The app must not have published to Open testing or Production tracks." + }, + "pemUploadCertificate": { + "description": "The certificate associated with the upload key, in PEM format.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "EnrollAppResponse": { + "description": "Response to enroll an app into Play signing.", + "id": "EnrollAppResponse", + "properties": { + "signingCertificate": { + "$ref": "CertificateHashes", + "description": "The signing certificate hashes for the app. Always set." + }, + "uploadCertificate": { + "$ref": "CertificateHashes", + "description": "The upload certificate hashes for the app. Set iff pem_upload_certificate was set in the request." + } + }, + "type": "object" + }, + "EnrollExistingApp": { + "description": "Enroll an existing app into Play signing.", + "id": "EnrollExistingApp", + "properties": { + "cloudKmsKey": { + "$ref": "CloudKmsKey", + "description": "Required. Self-hosted key. Once enrolled, this key will be used to sign your app." + } + }, + "type": "object" + }, + "EnrollNewApp": { + "description": "Enroll a new app into Play signing.", + "id": "EnrollNewApp", + "properties": { + "cloudKmsKeyAndCert": { + "$ref": "CloudKmsKeyAndCert", + "description": "Required. Self-hosted key. Once enrolled, this key will be used to sign your app." + } + }, + "type": "object" + }, "ExpansionFile": { "description": "An expansion file. The resource for ExpansionFilesService.", "id": "ExpansionFile", @@ -12643,6 +12804,64 @@ "properties": {}, "type": "object" }, + "RotateAppSigningKeyRequest": { + "description": "Request to rotate an app's signing key.", + "id": "RotateAppSigningKeyRequest", + "properties": { + "keyRotationReason": { + "description": "Required. Reason for rotating the app key.", + "enum": [ + "KEY_ROTATION_REASON_UNSPECIFIED", + "COMPROMISED_KEY", + "USE_STRONGER_KEY", + "USE_SAME_KEY_FOR_MULTIPLE_APPS", + "ROUTINE_KEY_UPGRADE", + "OTHER" + ], + "enumDescriptions": [ + "Unspecified key rotation reason. Cannot be used.", + "Key is compromised.", + "Stronger key is required.", + "Same key is used for multiple apps.", + "Routine key upgrade.", + "Other reason." + ], + "type": "string" + }, + "rotatedCloudKmsKey": { + "$ref": "RotatedCloudKmsKey", + "description": "Required. Self-hosted Cloud KMS key." + } + }, + "type": "object" + }, + "RotateAppSigningKeyResponse": { + "description": "Response to rotate an app's signing key.", + "id": "RotateAppSigningKeyResponse", + "properties": { + "rotatedKeyCertificate": { + "$ref": "CertificateHashes", + "description": "The rotated key certificate hashes for the app. Always set." + } + }, + "type": "object" + }, + "RotatedCloudKmsKey": { + "description": "Message representing rotated Cloud KMS key. Consists of the Cloud KMS key and its associated proof of rotation.", + "id": "RotatedCloudKmsKey", + "properties": { + "cloudKmsKeyAndCert": { + "$ref": "CloudKmsKeyAndCert", + "description": "Required. Cloud KMS key and the certificate associated with the key." + }, + "signingCertificateLineage": { + "description": "Required. Proof-of-rotation. See [creating signing certificate lineages](https://developer.android.com/studio/command-line/apksigner#rotate_signing_keys_2).", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "SafetyLabelsUpdateRequest": { "description": "Request to update Safety Labels of an app.", "id": "SafetyLabelsUpdateRequest", diff --git a/discovery/apigeeregistry-v1.json b/discovery/apigeeregistry-v1.json deleted file mode 100644 index f5de99869d4..00000000000 --- a/discovery/apigeeregistry-v1.json +++ /dev/null @@ -1,4191 +0,0 @@ -{ - "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://apigeeregistry.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Apigee Registry", - "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": "apigeeregistry:v1", - "kind": "discovery#restDescription", - "mtlsRootUrl": "https://apigeeregistry.mtls.googleapis.com/", - "name": "apigeeregistry", - "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": "apigeeregistry.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": "apigeeregistry.projects.locations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "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": { - "apis": { - "methods": { - "create": { - "description": "Creates a specified API.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "apiId": { - "description": "Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of APIs. Format: `projects/*/locations/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/apis", - "request": { - "$ref": "Api" - }, - "response": { - "$ref": "Api" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Removes a specified API and all of the resources that it owns.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the API to delete. Format: `projects/*/locations/*/apis/*`", - "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": "Returns a specified API.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the API to retrieve. Format: `projects/*/locations/*/apis/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Api" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.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/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Returns matching APIs.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters 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 APIs. Format: `projects/*/locations/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/apis", - "response": { - "$ref": "ListApisResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Used to modify a specified API.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}", - "httpMethod": "PATCH", - "id": "apigeeregistry.projects.locations.apis.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "allowMissing": { - "description": "If set to true, and the API is not found, a new API will be created. In this situation, `update_mask` is ignored.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk \"*\" is specified, all fields are updated, including fields that are unspecified/default in the request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "Api" - }, - "response": { - "$ref": "Api" - }, - "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}/apis/{apisId}:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.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/[^/]+/apis/[^/]+$", - "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}/apis/{apisId}:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.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/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "artifacts": { - "methods": { - "create": { - "description": "Creates a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.artifacts.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "artifactId": { - "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Removes a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.artifacts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Returns a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.artifacts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getContents": { - "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getContents", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.artifacts.getContents", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:getContents", - "response": { - "$ref": "HttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.artifacts.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/[^/]+/apis/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Returns matching artifacts.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.artifacts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "response": { - "$ref": "ListArtifactsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "replaceArtifact": { - "description": "Used to replace a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/artifacts/{artifactsId}", - "httpMethod": "PUT", - "id": "apigeeregistry.projects.locations.apis.artifacts.replaceArtifact", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "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}/apis/{apisId}/artifacts/{artifactsId}:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.artifacts.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/[^/]+/apis/[^/]+/artifacts/[^/]+$", - "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}/apis/{apisId}/artifacts/{artifactsId}:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.artifacts.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/[^/]+/apis/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "deployments": { - "methods": { - "create": { - "description": "Creates a specified deployment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.deployments.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "apiDeploymentId": { - "description": "Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/deployments", - "request": { - "$ref": "ApiDeployment" - }, - "response": { - "$ref": "ApiDeployment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.deployments.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the deployment to delete. Format: `projects/*/locations/*/apis/*/deployments/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "deleteRevision": { - "description": "Deletes a revision of a deployment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:deleteRevision", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.deployments.deleteRevision", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:deleteRevision", - "response": { - "$ref": "ApiDeployment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Returns a specified deployment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.deployments.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the deployment to retrieve. Format: `projects/*/locations/*/apis/*/deployments/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "ApiDeployment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.deployments.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/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Returns matching deployments.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.deployments.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListApiDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiDeployments` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of deployments. Format: `projects/*/locations/*/apis/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/deployments", - "response": { - "$ref": "ListApiDeploymentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "listRevisions": { - "description": "Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:listRevisions", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.deployments.listRevisions", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the deployment to list revisions for.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The maximum number of revisions to return per page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:listRevisions", - "response": { - "$ref": "ListApiDeploymentRevisionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Used to modify a specified deployment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}", - "httpMethod": "PATCH", - "id": "apigeeregistry.projects.locations.apis.deployments.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "allowMissing": { - "description": "If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk \"*\" is specified, all fields are updated, including fields that are unspecified/default in the request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "ApiDeployment" - }, - "response": { - "$ref": "ApiDeployment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "rollback": { - "description": "Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:rollback", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.deployments.rollback", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The deployment being rolled back.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:rollback", - "request": { - "$ref": "RollbackApiDeploymentRequest" - }, - "response": { - "$ref": "ApiDeployment" - }, - "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}/apis/{apisId}/deployments/{deploymentsId}:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.deployments.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/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "tagRevision": { - "description": "Adds a tag to a specified revision of a deployment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}:tagRevision", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.deployments.tagRevision", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the deployment to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:tagRevision", - "request": { - "$ref": "TagApiDeploymentRevisionRequest" - }, - "response": { - "$ref": "ApiDeployment" - }, - "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}/apis/{apisId}/deployments/{deploymentsId}:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.deployments.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/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "artifacts": { - "methods": { - "create": { - "description": "Creates a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "artifactId": { - "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Removes a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Returns a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getContents": { - "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}:getContents", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.getContents", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:getContents", - "response": { - "$ref": "HttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Returns matching artifacts.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "response": { - "$ref": "ListArtifactsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "replaceArtifact": { - "description": "Used to replace a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/deployments/{deploymentsId}/artifacts/{artifactsId}", - "httpMethod": "PUT", - "id": "apigeeregistry.projects.locations.apis.deployments.artifacts.replaceArtifact", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/deployments/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "versions": { - "methods": { - "create": { - "description": "Creates a specified version.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "apiVersionId": { - "description": "Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/versions", - "request": { - "$ref": "ApiVersion" - }, - "response": { - "$ref": "ApiVersion" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Removes a specified version and all of the resources that it owns.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.versions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the version to delete. Format: `projects/*/locations/*/apis/*/versions/*`", - "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": "Returns a specified version.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the version to retrieve. Format: `projects/*/locations/*/apis/*/versions/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "ApiVersion" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.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/[^/]+/apis/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Returns matching versions.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListApiVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiVersions` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of versions. Format: `projects/*/locations/*/apis/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/versions", - "response": { - "$ref": "ListApiVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Used to modify a specified version.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}", - "httpMethod": "PATCH", - "id": "apigeeregistry.projects.locations.apis.versions.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "allowMissing": { - "description": "If set to true, and the version is not found, a new version will be created. In this situation, `update_mask` is ignored.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk \"*\" is specified, all fields are updated, including fields that are unspecified/default in the request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "ApiVersion" - }, - "response": { - "$ref": "ApiVersion" - }, - "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}/apis/{apisId}/versions/{versionsId}:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.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/[^/]+/apis/[^/]+/versions/[^/]+$", - "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}/apis/{apisId}/versions/{versionsId}:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.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/[^/]+/apis/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "artifacts": { - "methods": { - "create": { - "description": "Creates a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.artifacts.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "artifactId": { - "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Removes a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.versions.artifacts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Returns a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.artifacts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getContents": { - "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getContents", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.artifacts.getContents", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:getContents", - "response": { - "$ref": "HttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.artifacts.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/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Returns matching artifacts.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.artifacts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "response": { - "$ref": "ListArtifactsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "replaceArtifact": { - "description": "Used to replace a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}", - "httpMethod": "PUT", - "id": "apigeeregistry.projects.locations.apis.versions.artifacts.replaceArtifact", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "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}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.artifacts.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/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", - "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}/apis/{apisId}/versions/{versionsId}/artifacts/{artifactsId}:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.artifacts.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/[^/]+/apis/[^/]+/versions/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "specs": { - "methods": { - "create": { - "description": "Creates a specified spec.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.specs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "apiSpecId": { - "description": "Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of specs. Format: `projects/*/locations/*/apis/*/versions/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/specs", - "request": { - "$ref": "ApiSpec" - }, - "response": { - "$ref": "ApiSpec" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Removes a specified spec, all revisions, and all child resources (e.g., artifacts).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.versions.specs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the spec to delete. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`", - "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" - ] - }, - "deleteRevision": { - "description": "Deletes a revision of a spec.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:deleteRevision", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.versions.specs.deleteRevision", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:deleteRevision", - "response": { - "$ref": "ApiSpec" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Returns a specified spec.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.specs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the spec to retrieve. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "ApiSpec" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getContents": { - "description": "Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getContents", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.specs.getContents", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the spec whose contents should be retrieved. Format: `projects/*/locations/*/apis/*/versions/*/specs/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:getContents", - "response": { - "$ref": "HttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.specs.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/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Returns matching specs.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.specs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListApiSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiSpecs` 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/*/locations/*/apis/*/versions/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/specs", - "response": { - "$ref": "ListApiSpecsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "listRevisions": { - "description": "Lists all revisions of a spec. Revisions are returned in descending order of revision creation time.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:listRevisions", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.specs.listRevisions", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the spec to list revisions for.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The maximum number of revisions to return per page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:listRevisions", - "response": { - "$ref": "ListApiSpecRevisionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Used to modify a specified spec.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}", - "httpMethod": "PATCH", - "id": "apigeeregistry.projects.locations.apis.versions.specs.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "allowMissing": { - "description": "If set to true, and the spec is not found, a new spec will be created. In this situation, `update_mask` is ignored.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk \"*\" is specified, all fields are updated, including fields that are unspecified/default in the request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "ApiSpec" - }, - "response": { - "$ref": "ApiSpec" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "rollback": { - "description": "Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:rollback", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.specs.rollback", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The spec being rolled back.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:rollback", - "request": { - "$ref": "RollbackApiSpecRequest" - }, - "response": { - "$ref": "ApiSpec" - }, - "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}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.specs.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/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "tagRevision": { - "description": "Adds a tag to a specified revision of a spec.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:tagRevision", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.specs.tagRevision", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the spec to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:tagRevision", - "request": { - "$ref": "TagApiSpecRevisionRequest" - }, - "response": { - "$ref": "ApiSpec" - }, - "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}/apis/{apisId}/versions/{versionsId}/specs/{specsId}:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.specs.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/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "artifacts": { - "methods": { - "create": { - "description": "Creates a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "artifactId": { - "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Removes a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Returns a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getContents": { - "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getContents", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.getContents", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:getContents", - "response": { - "$ref": "HttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.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/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Returns matching artifacts.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "response": { - "$ref": "ListArtifactsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "replaceArtifact": { - "description": "Used to replace a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}", - "httpMethod": "PUT", - "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.replaceArtifact", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "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}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.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/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", - "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}/apis/{apisId}/versions/{versionsId}/specs/{specsId}/artifacts/{artifactsId}:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.apis.versions.specs.artifacts.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/[^/]+/apis/[^/]+/versions/[^/]+/specs/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - } - } - }, - "artifacts": { - "methods": { - "create": { - "description": "Creates a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.artifacts.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "artifactId": { - "description": "Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Removes a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.artifacts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to delete. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Returns a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.artifacts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact to retrieve. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getContents": { - "description": "Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getContents", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.artifacts.getContents", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the artifact whose contents should be retrieved. Format: `{parent}/artifacts/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:getContents", - "response": { - "$ref": "HttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.artifacts.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/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Returns matching artifacts.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.artifacts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields, e.g. \"foo,bar\" Fields can be sorted in descending order using the \"desc\" identifier, e.g. \"foo desc,bar\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of artifacts. Format: `{parent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/artifacts", - "response": { - "$ref": "ListArtifactsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "replaceArtifact": { - "description": "Used to replace a specified artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/artifacts/{artifactsId}", - "httpMethod": "PUT", - "id": "apigeeregistry.projects.locations.artifacts.replaceArtifact", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "Artifact" - }, - "response": { - "$ref": "Artifact" - }, - "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}/artifacts/{artifactsId}:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.artifacts.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/[^/]+/artifacts/[^/]+$", - "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}/artifacts/{artifactsId}:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.artifacts.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/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "documents": { - "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/documents:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.documents.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/[^/]+/documents$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/documents:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.documents.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/[^/]+/documents$", - "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}/documents:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.documents.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/[^/]+/documents$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "instances": { - "methods": { - "create": { - "description": "Provisions instance resources for the Registry.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.instances.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "instanceId": { - "description": "Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Parent resource of the Instance, of the form: `projects/*/locations/*`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/instances", - "request": { - "$ref": "Instance" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes the Registry instance.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", - "httpMethod": "DELETE", - "id": "apigeeregistry.projects.locations.instances.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Instance to delete. Format: `projects/*/locations/*/instances/*`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "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 Instance.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.instances.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Instance to retrieve. Format: `projects/*/locations/*/instances/*`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Instance" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.instances.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/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.instances.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/[^/]+/instances/[^/]+$", - "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}/instances/{instancesId}:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.instances.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/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "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": "apigeeregistry.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": "apigeeregistry.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": "apigeeregistry.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": "apigeeregistry.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" - ] - } - } - }, - "runtime": { - "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtime:getIamPolicy", - "httpMethod": "GET", - "id": "apigeeregistry.projects.locations.runtime.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/[^/]+/runtime$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtime:setIamPolicy", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.runtime.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/[^/]+/runtime$", - "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}/runtime:testIamPermissions", - "httpMethod": "POST", - "id": "apigeeregistry.projects.locations.runtime.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/[^/]+/runtime$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - } - }, - "revision": "20230928", - "rootUrl": "https://apigeeregistry.googleapis.com/", - "schemas": { - "Api": { - "description": "A top-level description of an API. Produced by producers and are commitments to provide services.", - "id": "Api", - "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", - "type": "object" - }, - "availability": { - "description": "A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., \"NONE\", \"TESTING\", \"PREVIEW\", \"GENERAL\", \"DEPRECATED\", \"SHUTDOWN\".", - "type": "string" - }, - "createTime": { - "description": "Output only. Creation timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "A detailed description.", - "type": "string" - }, - "displayName": { - "description": "Human-meaningful name.", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed.", - "type": "object" - }, - "name": { - "description": "Resource name.", - "type": "string" - }, - "recommendedDeployment": { - "description": "The recommended deployment of the API. Format: `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}`", - "type": "string" - }, - "recommendedVersion": { - "description": "The recommended version of the API. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`", - "type": "string" - }, - "updateTime": { - "description": "Output only. Last update timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "ApiDeployment": { - "description": "Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.", - "id": "ApiDeployment", - "properties": { - "accessGuidance": { - "description": "Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.", - "type": "string" - }, - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", - "type": "object" - }, - "apiSpecRevision": { - "description": "The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}`", - "type": "string" - }, - "createTime": { - "description": "Output only. Creation timestamp; when the deployment resource was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "A detailed description.", - "type": "string" - }, - "displayName": { - "description": "Human-meaningful name.", - "type": "string" - }, - "endpointUri": { - "description": "The address where the deployment is serving. Changes to this value will update the revision.", - "type": "string" - }, - "externalChannelUri": { - "description": "The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.", - "type": "string" - }, - "intendedAudience": { - "description": "Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed.", - "type": "object" - }, - "name": { - "description": "Resource name.", - "type": "string" - }, - "revisionCreateTime": { - "description": "Output only. Revision creation timestamp; when the represented revision was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "revisionId": { - "description": "Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.", - "readOnly": true, - "type": "string" - }, - "revisionUpdateTime": { - "description": "Output only. Last update timestamp: when the represented revision was last modified.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "ApiSpec": { - "description": "Describes a version of an API in a structured way. ApiSpecs provide formal descriptions that consumers can use to use a version. ApiSpec resources are intended to be fully-resolved descriptions of an ApiVersion. When specs consist of multiple files, these should be bundled together (e.g., in a zip archive) and stored as a unit. Multiple specs can exist to provide representations in different API description formats. Synchronization of these representations would be provided by tooling and background services.", - "id": "ApiSpec", - "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", - "type": "object" - }, - "contents": { - "description": "Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.", - "format": "byte", - "type": "string" - }, - "createTime": { - "description": "Output only. Creation timestamp; when the spec resource was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "A detailed description.", - "type": "string" - }, - "filename": { - "description": "A possibly-hierarchical name used to refer to the spec from other specs.", - "type": "string" - }, - "hash": { - "description": "Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.", - "readOnly": true, - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed.", - "type": "object" - }, - "mimeType": { - "description": "A style (format) descriptor for this spec that is specified as a [Media Type](https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with \"+gzip\").", - "type": "string" - }, - "name": { - "description": "Resource name.", - "type": "string" - }, - "revisionCreateTime": { - "description": "Output only. Revision creation timestamp; when the represented revision was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "revisionId": { - "description": "Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string.", - "readOnly": true, - "type": "string" - }, - "revisionUpdateTime": { - "description": "Output only. Last update timestamp: when the represented revision was last modified.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "sizeBytes": { - "description": "Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "sourceUri": { - "description": "The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.", - "type": "string" - } - }, - "type": "object" - }, - "ApiVersion": { - "description": "Describes a particular version of an API. ApiVersions are what consumers actually use.", - "id": "ApiVersion", - "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", - "type": "object" - }, - "createTime": { - "description": "Output only. Creation timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "A detailed description.", - "type": "string" - }, - "displayName": { - "description": "Human-meaningful name.", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed.", - "type": "object" - }, - "name": { - "description": "Resource name.", - "type": "string" - }, - "primarySpec": { - "description": "The primary spec for this version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}", - "type": "string" - }, - "state": { - "description": "A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., \"CONCEPT\", \"DESIGN\", \"DEVELOPMENT\", \"STAGING\", \"PRODUCTION\", \"DEPRECATED\", \"RETIRED\".", - "type": "string" - }, - "updateTime": { - "description": "Output only. Last update timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "Artifact": { - "description": "Artifacts of resources. Artifacts are unique (single-value) per resource and are used to store metadata that is too large or numerous to be stored directly on the resource. Since artifacts are stored separately from parent resources, they should generally be used for metadata that is needed infrequently, i.e., not for display in primary views of the resource but perhaps displayed or downloaded upon request. The `ListArtifacts` method allows artifacts to be quickly enumerated and checked for presence without downloading their (potentially-large) contents.", - "id": "Artifact", - "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.", - "type": "object" - }, - "contents": { - "description": "Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents.", - "format": "byte", - "type": "string" - }, - "createTime": { - "description": "Output only. Creation timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "hash": { - "description": "Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact.", - "readOnly": true, - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"registry.googleapis.com/\" and cannot be changed.", - "type": "object" - }, - "mimeType": { - "description": "A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible \"schema\" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with \"+gzip\").", - "type": "string" - }, - "name": { - "description": "Resource name.", - "type": "string" - }, - "sizeBytes": { - "description": "Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "updateTime": { - "description": "Output only. Last update timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "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`. * `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.", - "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`.", - "type": "string" - } - }, - "type": "object" - }, - "Build": { - "description": "Build information of the Instance if it's in `ACTIVE` state.", - "id": "Build", - "properties": { - "commitId": { - "description": "Output only. Commit ID of the latest commit in the build.", - "readOnly": true, - "type": "string" - }, - "commitTime": { - "description": "Output only. Commit time of the latest commit in the build.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "repo": { - "description": "Output only. Path of the open source repository: github.com/apigee/registry.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "properties": {}, - "type": "object" - }, - "Config": { - "description": "Available configurations to provision an Instance.", - "id": "Config", - "properties": { - "cmekKeyName": { - "description": "Required. 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 InstanceConfig.location.", - "type": "string" - }, - "location": { - "description": "Output only. The GCP location where the Instance resides.", - "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" - }, - "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" - }, - "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" - }, - "Instance": { - "description": "An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project.", - "id": "Instance", - "properties": { - "build": { - "$ref": "Build", - "description": "Output only. Build info of the Instance if it's in `ACTIVE` state.", - "readOnly": true - }, - "config": { - "$ref": "Config", - "description": "Required. Config of the Instance." - }, - "createTime": { - "description": "Output only. Creation timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Format: `projects/*/locations/*/instance`. Currently only `locations/global` is supported.", - "type": "string" - }, - "state": { - "description": "Output only. The current state of the Instance.", - "enum": [ - "STATE_UNSPECIFIED", - "INACTIVE", - "CREATING", - "ACTIVE", - "UPDATING", - "DELETING", - "FAILED" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "The Instance has not been initialized or has been deleted.", - "The Instance is being created.", - "The Instance has been created and is ready for use.", - "The Instance is being updated.", - "The Instance is being deleted.", - "The Instance encountered an error during a state change." - ], - "readOnly": true, - "type": "string" - }, - "stateMessage": { - "description": "Output only. Extra information of Instance.State if the state is `FAILED`.", - "readOnly": true, - "type": "string" - }, - "updateTime": { - "description": "Output only. Last update timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "ListApiDeploymentRevisionsResponse": { - "description": "Response message for ListApiDeploymentRevisionsResponse.", - "id": "ListApiDeploymentRevisionsResponse", - "properties": { - "apiDeployments": { - "description": "The revisions of the deployment.", - "items": { - "$ref": "ApiDeployment" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token that 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" - }, - "ListApiDeploymentsResponse": { - "description": "Response message for ListApiDeployments.", - "id": "ListApiDeploymentsResponse", - "properties": { - "apiDeployments": { - "description": "The deployments from the specified publisher.", - "items": { - "$ref": "ApiDeployment" - }, - "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" - }, - "ListApiSpecRevisionsResponse": { - "description": "Response message for ListApiSpecRevisionsResponse.", - "id": "ListApiSpecRevisionsResponse", - "properties": { - "apiSpecs": { - "description": "The revisions of the spec.", - "items": { - "$ref": "ApiSpec" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token that 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" - }, - "ListApiSpecsResponse": { - "description": "Response message for ListApiSpecs.", - "id": "ListApiSpecsResponse", - "properties": { - "apiSpecs": { - "description": "The specs from the specified publisher.", - "items": { - "$ref": "ApiSpec" - }, - "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" - }, - "ListApiVersionsResponse": { - "description": "Response message for ListApiVersions.", - "id": "ListApiVersionsResponse", - "properties": { - "apiVersions": { - "description": "The versions from the specified publisher.", - "items": { - "$ref": "ApiVersion" - }, - "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" - }, - "ListApisResponse": { - "description": "Response message for ListApis.", - "id": "ListApisResponse", - "properties": { - "apis": { - "description": "The APIs from the specified publisher.", - "items": { - "$ref": "Api" - }, - "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" - }, - "ListArtifactsResponse": { - "description": "Response message for ListArtifacts.", - "id": "ListArtifactsResponse", - "properties": { - "artifacts": { - "description": "The artifacts from the specified publisher.", - "items": { - "$ref": "Artifact" - }, - "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" - }, - "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" - }, - "Location": { - "description": "A resource that represents a Google Cloud location.", - "id": "Location", - "properties": { - "displayName": { - "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object" - }, - "locationId": { - "description": "The canonical id for this location. For example: `\"us-east1\"`.", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata. For example the available capacity at the given location.", - "type": "object" - }, - "name": { - "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", - "type": "string" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, - "OperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "OperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "cancellationRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "statusMessage": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "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": { - "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" - }, - "RollbackApiDeploymentRequest": { - "description": "Request message for RollbackApiDeployment.", - "id": "RollbackApiDeploymentRequest", - "properties": { - "revisionId": { - "description": "Required. The revision ID to roll back to. It must be a revision of the same deployment. Example: `c7cfa2a8`", - "type": "string" - } - }, - "type": "object" - }, - "RollbackApiSpecRequest": { - "description": "Request message for RollbackApiSpec.", - "id": "RollbackApiSpecRequest", - "properties": { - "revisionId": { - "description": "Required. The revision ID to roll back to. It must be a revision of the same spec. Example: `c7cfa2a8`", - "type": "string" - } - }, - "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." - } - }, - "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" - }, - "TagApiDeploymentRevisionRequest": { - "description": "Request message for TagApiDeploymentRevision.", - "id": "TagApiDeploymentRevisionRequest", - "properties": { - "tag": { - "description": "Required. The tag to apply. The tag should be at most 40 characters, and match `a-z{3,39}`.", - "type": "string" - } - }, - "type": "object" - }, - "TagApiSpecRevisionRequest": { - "description": "Request message for TagApiSpecRevision.", - "id": "TagApiSpecRevisionRequest", - "properties": { - "tag": { - "description": "Required. The tag to apply. The tag should be at most 40 characters, and match `a-z{3,39}`.", - "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": "", - "title": "Apigee Registry API", - "version": "v1", - "version_module": true -} \ No newline at end of file diff --git a/discovery/apihub-v1.json b/discovery/apihub-v1.json index e3f67922063..6a17255d3ab 100644 --- a/discovery/apihub-v1.json +++ b/discovery/apihub-v1.json @@ -3435,7 +3435,7 @@ } } }, - "revision": "20260729", + "revision": "20260819", "rootUrl": "https://apihub.googleapis.com/", "schemas": { "Empty": { @@ -3665,11 +3665,11 @@ "properties": { "apiFunctionalRequirements": { "$ref": "GoogleCloudApihubV1AttributeValues", - "description": "Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory." + "description": "Optional. The api functional requirements associated with the API resource. Cardinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory." }, "apiRequirements": { "$ref": "GoogleCloudApihubV1AttributeValues", - "description": "Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory." + "description": "Optional. The api requirement doc associated with the API resource. Cardinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory." }, "apiStyle": { "$ref": "GoogleCloudApihubV1AttributeValues", @@ -3677,7 +3677,7 @@ }, "apiTechnicalRequirements": { "$ref": "GoogleCloudApihubV1AttributeValues", - "description": "Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory." + "description": "Optional. The api technical requirements associated with the API resource. Cardinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory." }, "attributes": { "additionalProperties": { diff --git a/discovery/apikeys-v2.json b/discovery/apikeys-v2.json index e290d854a76..edf56f8726c 100644 --- a/discovery/apikeys-v2.json +++ b/discovery/apikeys-v2.json @@ -2,6 +2,12 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/apikeys": { + "description": "See, edit, configure, and delete your Google Cloud API Keys data and see the email address for your Google Account" + }, + "https://www.googleapis.com/auth/apikeys.readonly": { + "description": "See your Google Cloud API Keys data and the email address of your Google Account" + }, "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." }, @@ -128,6 +134,8 @@ "$ref": "V2LookupKeyResponse" }, "scopes": [ + "https://www.googleapis.com/auth/apikeys", + "https://www.googleapis.com/auth/apikeys.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -158,6 +166,8 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/apikeys", + "https://www.googleapis.com/auth/apikeys.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -200,6 +210,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/apikeys", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -245,6 +256,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/apikeys", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -270,6 +282,8 @@ "$ref": "V2Key" }, "scopes": [ + "https://www.googleapis.com/auth/apikeys", + "https://www.googleapis.com/auth/apikeys.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -296,6 +310,8 @@ "$ref": "V2GetKeyStringResponse" }, "scopes": [ + "https://www.googleapis.com/auth/apikeys", + "https://www.googleapis.com/auth/apikeys.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -338,6 +354,8 @@ "$ref": "V2ListKeysResponse" }, "scopes": [ + "https://www.googleapis.com/auth/apikeys", + "https://www.googleapis.com/auth/apikeys.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -388,6 +406,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/apikeys", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -416,6 +435,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/apikeys", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -426,7 +446,7 @@ } } }, - "revision": "20260731", + "revision": "20260818", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index c83c680bac4..a9414049295 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -2725,7 +2725,7 @@ } } }, - "revision": "20260805", + "revision": "20260812", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -5173,6 +5173,10 @@ }, "type": "array" }, + "instanceBackupSource": { + "$ref": "RestoreDiskFromInstanceOptions", + "description": "Provides options for creating a disk from a source Compute Instance backup." + }, "labels": { "additionalProperties": { "type": "string" @@ -6839,6 +6843,21 @@ }, "type": "object" }, + "RestoreDiskFromInstanceOptions": { + "description": "Options for creating a disk from a source Compute Instance backup.", + "id": "RestoreDiskFromInstanceOptions", + "properties": { + "bootDisk": { + "description": "Specifies that the boot disk should be restored from the instance backup. This field should only be set to `true` if selected.", + "type": "boolean" + }, + "sourceDeviceName": { + "description": "The device name of the disk to restore from the VM backup.", + "type": "string" + } + }, + "type": "object" + }, "RuleConfigInfo": { "description": "Message for rules config info.", "id": "RuleConfigInfo", diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index 85e0019be40..aab8a83d506 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -2390,7 +2390,7 @@ } } }, - "revision": "20260731", + "revision": "20260811", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -5059,7 +5059,7 @@ "description": "Job level error stats across all GenAi functions" }, "functionStats": { - "description": "Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview", + "description": "Function level stats for GenAI Functions. For more information, see [Generative AI overview](https://docs.cloud.google.com/bigquery/docs/generative-ai-overview).", "items": { "$ref": "GenAiFunctionStats" }, @@ -10657,7 +10657,7 @@ "Replication is Active with no errors.", "Source object is deleted.", "Source revoked replication permissions.", - "Source configuration doesn’t allow replication." + "Source configuration doesn't allow replication." ], "readOnly": true, "type": "string" diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index 931d29509b0..cfaf7005d7a 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -2077,7 +2077,7 @@ } } }, - "revision": "20260809", + "revision": "20260815", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessPermissionSetting": { @@ -2260,7 +2260,7 @@ "type": "object" }, "Annotation": { - "description": "Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```", + "description": "Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```", "id": "Annotation", "properties": { "customEmojiMetadata": { diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 64add821bcf..311f478d6f5 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -1296,7 +1296,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id`", + "description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` * `learning_goals`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2515,7 +2515,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id`", + "description": "Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id` * `learning_goals`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4376,7 +4376,7 @@ } } }, - "revision": "20260708", + "revision": "20260816", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index 061509140c9..504bbb8cd48 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -491,7 +491,7 @@ ] }, "cancel": { - "description": "Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.", + "description": "Cancels a build in progress. Note: This method only cancels builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}:cancel. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.", "flatPath": "v1/projects/{projectId}/builds/{id}:cancel", "httpMethod": "POST", "id": "cloudbuild.projects.builds.cancel", @@ -525,7 +525,7 @@ ] }, "create": { - "description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To create regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", + "description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectId}/builds", "httpMethod": "POST", "id": "cloudbuild.projects.builds.create", @@ -557,7 +557,7 @@ ] }, "get": { - "description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}`. To fetch regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.", + "description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only gets builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.", "flatPath": "v1/projects/{projectId}/builds/{id}", "httpMethod": "GET", "id": "cloudbuild.projects.builds.get", @@ -593,7 +593,7 @@ ] }, "list": { - "description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To list regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", + "description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectId}/builds", "httpMethod": "GET", "id": "cloudbuild.projects.builds.list", @@ -638,7 +638,7 @@ ] }, "retry": { - "description": "Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", + "description": "Creates a new build based on the specified build. Note: This method only creates builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}:retry. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", "flatPath": "v1/projects/{projectId}/builds/{id}:retry", "httpMethod": "POST", "id": "cloudbuild.projects.builds.retry", @@ -1174,7 +1174,7 @@ ] }, "cancel": { - "description": "Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.", + "description": "Cancels a build in progress. Note: This method only cancels builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}:cancel. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:cancel", "httpMethod": "POST", "id": "cloudbuild.projects.locations.builds.cancel", @@ -1202,7 +1202,7 @@ ] }, "create": { - "description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To create regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", + "description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds", "httpMethod": "POST", "id": "cloudbuild.projects.locations.builds.create", @@ -1235,7 +1235,7 @@ ] }, "get": { - "description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}`. To fetch regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.", + "description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only gets builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}", "httpMethod": "GET", "id": "cloudbuild.projects.locations.builds.get", @@ -1270,7 +1270,7 @@ ] }, "list": { - "description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To list regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", + "description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds", "httpMethod": "GET", "id": "cloudbuild.projects.locations.builds.list", @@ -1316,7 +1316,7 @@ ] }, "retry": { - "description": "Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", + "description": "Creates a new build based on the specified build. Note: This method only creates builds in the \"global\" region when using the legacy resource path projects/{project_id}/builds/{id}:retry. For all regions, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:retry", "httpMethod": "POST", "id": "cloudbuild.projects.locations.builds.retry", @@ -1345,275 +1345,6 @@ } } }, - "gitLabConfigs": { - "methods": { - "create": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Creates a new `GitLabConfig`. This API is experimental", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs", - "httpMethod": "POST", - "id": "cloudbuild.projects.locations.gitLabConfigs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "gitlabConfigId": { - "description": "Optional. The ID to use for the GitLabConfig, which will become the final component of the GitLabConfig’s resource name. gitlab_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Name of the parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/gitLabConfigs", - "request": { - "$ref": "GitLabConfig" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Delete a `GitLabConfig`. This API is experimental", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}", - "httpMethod": "DELETE", - "id": "cloudbuild.projects.locations.gitLabConfigs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The config resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gitLabConfigs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Retrieves a `GitLabConfig`. This API is experimental", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}", - "httpMethod": "GET", - "id": "cloudbuild.projects.locations.gitLabConfigs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The config resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gitLabConfigs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GitLabConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. List all `GitLabConfigs` for a given project. This API is experimental", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs", - "httpMethod": "GET", - "id": "cloudbuild.projects.locations.gitLabConfigs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 50 configs will be returned. The maximum value is 1000;, values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous ‘ListGitlabConfigsRequest’ call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ‘ListGitlabConfigsRequest’ must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Name of the parent resource", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/gitLabConfigs", - "response": { - "$ref": "ListGitLabConfigsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Updates an existing `GitLabConfig`. This API is experimental", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}", - "httpMethod": "PATCH", - "id": "cloudbuild.projects.locations.gitLabConfigs.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name for the config.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gitLabConfigs/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GitLabConfig" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "removeGitLabConnectedRepository": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}:removeGitLabConnectedRepository", - "httpMethod": "POST", - "id": "cloudbuild.projects.locations.gitLabConfigs.removeGitLabConnectedRepository", - "parameterOrder": [ - "config" - ], - "parameters": { - "config": { - "description": "Required. The name of the `GitLabConfig` to remove a connected repository. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gitLabConfigs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+config}:removeGitLabConnectedRepository", - "request": { - "$ref": "RemoveGitLabConnectedRepositoryRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "connectedRepositories": { - "deprecated": true, - "methods": { - "batchCreate": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Batch connecting GitLab repositories to Cloud Build. This API is experimental.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}/connectedRepositories:batchCreate", - "httpMethod": "POST", - "id": "cloudbuild.projects.locations.gitLabConfigs.connectedRepositories.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "The name of the `GitLabConfig` that adds connected repositories. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gitLabConfigs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/connectedRepositories:batchCreate", - "request": { - "$ref": "BatchCreateGitLabConnectedRepositoriesRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "repos": { - "deprecated": true, - "methods": { - "list": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. List all repositories for a given `GitLabConfig`. This API is experimental", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}/repos", - "httpMethod": "GET", - "id": "cloudbuild.projects.locations.gitLabConfigs.repos.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of repositories to return. The service may return fewer than this value.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous ListGitLabRepositoriesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGitLabRepositoriesRequest` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Name of the parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gitLabConfigs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/repos", - "response": { - "$ref": "ListGitLabRepositoriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, "githubEnterpriseConfigs": { "methods": { "create": { @@ -2593,7 +2324,7 @@ } } }, - "revision": "20260627", + "revision": "20260814", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -2808,58 +2539,6 @@ }, "type": "object" }, - "BatchCreateGitLabConnectedRepositoriesRequest": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method.", - "id": "BatchCreateGitLabConnectedRepositoriesRequest", - "properties": { - "requests": { - "description": "Required. Requests to connect GitLab repositories.", - "items": { - "$ref": "CreateGitLabConnectedRepositoryRequest" - }, - "type": "array" - } - }, - "type": "object" - }, - "BatchCreateGitLabConnectedRepositoriesResponse": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Response of BatchCreateGitLabConnectedRepositories RPC method.", - "id": "BatchCreateGitLabConnectedRepositoriesResponse", - "properties": { - "gitlabConnectedRepositories": { - "description": "The GitLab connected repository requests' responses.", - "items": { - "$ref": "GitLabConnectedRepository" - }, - "type": "array" - } - }, - "type": "object" - }, - "BatchCreateGitLabConnectedRepositoriesResponseMetadata": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `BatchCreateGitLabConnectedRepositories` operation.", - "id": "BatchCreateGitLabConnectedRepositoriesResponseMetadata", - "properties": { - "completeTime": { - "description": "Time the operation was completed.", - "format": "google-datetime", - "type": "string" - }, - "config": { - "description": "The name of the `GitLabConfig` that added connected repositories. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}`", - "type": "string" - }, - "createTime": { - "description": "Time the operation was created.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, "BitbucketServerConfig": { "description": "BitbucketServerConfig represents the configuration for a Bitbucket Server.", "id": "BitbucketServerConfig", @@ -3696,11 +3375,6 @@ "$ref": "GitHubEventsConfig", "description": "GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`." }, - "gitlabEnterpriseEventsConfig": { - "$ref": "GitLabEventsConfig", - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received." - }, "id": { "description": "Output only. Unique identifier of the trigger.", "readOnly": true, @@ -3922,44 +3596,6 @@ }, "type": "object" }, - "CreateGitLabConfigOperationMetadata": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `CreateGitLabConfig` operation.", - "id": "CreateGitLabConfigOperationMetadata", - "properties": { - "completeTime": { - "description": "Time the operation was completed.", - "format": "google-datetime", - "type": "string" - }, - "createTime": { - "description": "Time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "gitlabConfig": { - "description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.", - "type": "string" - } - }, - "type": "object" - }, - "CreateGitLabConnectedRepositoryRequest": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Request to connect a repository from a connected GitLab host.", - "id": "CreateGitLabConnectedRepositoryRequest", - "properties": { - "gitlabConnectedRepository": { - "$ref": "GitLabConnectedRepository", - "description": "Required. The GitLab repository to connect." - }, - "parent": { - "description": "Required. The name of the `GitLabConfig` that adds connected repository. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}`", - "type": "string" - } - }, - "type": "object" - }, "CreateWorkerPoolOperationMetadata": { "description": "Metadata for the `CreateWorkerPool` operation.", "id": "CreateWorkerPoolOperationMetadata", @@ -4039,28 +3675,6 @@ }, "type": "object" }, - "DeleteGitLabConfigOperationMetadata": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `DeleteGitLabConfig` operation.", - "id": "DeleteGitLabConfigOperationMetadata", - "properties": { - "completeTime": { - "description": "Time the operation was completed.", - "format": "google-datetime", - "type": "string" - }, - "createTime": { - "description": "Time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "gitlabConfig": { - "description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.", - "type": "string" - } - }, - "type": "object" - }, "DeleteWorkerPoolOperationMetadata": { "description": "Metadata for the `DeleteWorkerPool` operation.", "id": "DeleteWorkerPoolOperationMetadata", @@ -4429,187 +4043,6 @@ }, "type": "object" }, - "GitLabConfig": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration.", - "id": "GitLabConfig", - "properties": { - "connectedRepositories": { - "description": "Connected GitLab.com or GitLabEnterprise repositories for this config.", - "items": { - "$ref": "GitLabRepositoryId" - }, - "type": "array" - }, - "createTime": { - "description": "Output only. Time when the config was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "enterpriseConfig": { - "$ref": "GitLabEnterpriseConfig", - "description": "Optional. GitLabEnterprise config." - }, - "name": { - "description": "Identifier. The resource name for the config.", - "type": "string" - }, - "secrets": { - "$ref": "GitLabSecrets", - "description": "Required. Secret Manager secrets needed by the config." - }, - "username": { - "description": "Username of the GitLab.com or GitLab Enterprise account Cloud Build will use.", - "type": "string" - }, - "webhookKey": { - "description": "Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GitLabConnectedRepository": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConnectedRepository represents a GitLab connected repository request response.", - "id": "GitLabConnectedRepository", - "properties": { - "parent": { - "description": "The name of the `GitLabConfig` that added connected repository. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}`", - "type": "string" - }, - "repo": { - "$ref": "GitLabRepositoryId", - "description": "The GitLab repositories to connect." - }, - "status": { - "$ref": "Status", - "description": "Output only. The status of the repo connection request.", - "readOnly": true - } - }, - "type": "object" - }, - "GitLabEnterpriseConfig": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration.", - "id": "GitLabEnterpriseConfig", - "properties": { - "hostUri": { - "description": "Immutable. The URI of the GitlabEnterprise host.", - "type": "string" - }, - "serviceDirectoryConfig": { - "$ref": "ServiceDirectoryConfig", - "description": "The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance." - }, - "sslCa": { - "description": "The SSL certificate to use in requests to GitLab Enterprise instances.", - "type": "string" - } - }, - "type": "object" - }, - "GitLabEventsConfig": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received.", - "id": "GitLabEventsConfig", - "properties": { - "gitlabConfig": { - "$ref": "GitLabConfig", - "description": "Output only. The GitLabConfig specified in the gitlab_config_resource field.", - "readOnly": true - }, - "gitlabConfigResource": { - "description": "The GitLab config resource that this trigger config maps to.", - "type": "string" - }, - "projectNamespace": { - "description": "Namespace of the GitLab project.", - "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, tags." - } - }, - "type": "object" - }, - "GitLabRepository": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Proto Representing a GitLabRepository", - "id": "GitLabRepository", - "properties": { - "browseUri": { - "description": "Link to the browse repo page on the GitLab instance", - "type": "string" - }, - "description": { - "description": "Description of the repository", - "type": "string" - }, - "displayName": { - "description": "Display name of the repository", - "type": "string" - }, - "name": { - "description": "The resource name of the repository", - "type": "string" - }, - "repositoryId": { - "$ref": "GitLabRepositoryId", - "description": "Identifier for a repository" - } - }, - "type": "object" - }, - "GitLabRepositoryId": { - "description": "GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise", - "id": "GitLabRepositoryId", - "properties": { - "id": { - "description": "Required. Identifier for the repository. example: \"namespace/project-slug\", namespace is usually the username or group ID", - "type": "string" - }, - "webhookId": { - "description": "Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.", - "format": "int32", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "GitLabSecrets": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration.", - "id": "GitLabSecrets", - "properties": { - "apiAccessTokenVersion": { - "description": "Required. The resource name for the api access token’s secret version", - "type": "string" - }, - "apiKeyVersion": { - "description": "Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build.", - "type": "string" - }, - "readAccessTokenVersion": { - "description": "Required. The resource name for the read access token’s secret version", - "type": "string" - }, - "webhookSecretVersion": { - "description": "Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig.", - "type": "string" - } - }, - "type": "object" - }, "GitRepoSource": { "description": "GitRepoSource describes a repo and ref of a code repository.", "id": "GitRepoSource", @@ -4689,6 +4122,10 @@ "description": "Required. Where should the files be placed on the worker.", "type": "string" }, + "fetchTags": { + "description": "Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags.", + "type": "boolean" + }, "recurseSubmodules": { "description": "Optional. True if submodules should be fetched too (default false).", "type": "boolean" @@ -4911,44 +4348,6 @@ }, "type": "object" }, - "ListGitLabConfigsResponse": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC response object returned by ListGitLabConfigs RPC method.", - "id": "ListGitLabConfigsResponse", - "properties": { - "gitlabConfigs": { - "description": "A list of GitLabConfigs", - "items": { - "$ref": "GitLabConfig" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token that 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" - }, - "ListGitLabRepositoriesResponse": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC response object returned by the ListGitLabRepositories RPC method.", - "id": "ListGitLabRepositoriesResponse", - "properties": { - "gitlabRepositories": { - "description": "List of GitLab repositories", - "items": { - "$ref": "GitLabRepository" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token that 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" - }, "ListGithubEnterpriseConfigsResponse": { "description": "RPC response object returned by ListGithubEnterpriseConfigs RPC method.", "id": "ListGithubEnterpriseConfigsResponse", @@ -5348,18 +4747,6 @@ }, "type": "object" }, - "RemoveGitLabConnectedRepositoryRequest": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC request object accepted by RemoveGitLabConnectedRepository RPC method.", - "id": "RemoveGitLabConnectedRepositoryRequest", - "properties": { - "connectedRepository": { - "$ref": "GitLabRepositoryId", - "description": "The connected repository to remove." - } - }, - "type": "object" - }, "RepoSource": { "description": "Location of the source in a Google Cloud Source Repository.", "id": "RepoSource", @@ -5620,18 +5007,6 @@ }, "type": "object" }, - "ServiceDirectoryConfig": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection.", - "id": "ServiceDirectoryConfig", - "properties": { - "service": { - "description": "The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.", - "type": "string" - } - }, - "type": "object" - }, "Source": { "description": "Location of the source in a supported storage service.", "id": "Source", @@ -5859,28 +5234,6 @@ }, "type": "object" }, - "UpdateGitLabConfigOperationMetadata": { - "deprecated": true, - "description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `UpdateGitLabConfig` operation.", - "id": "UpdateGitLabConfigOperationMetadata", - "properties": { - "completeTime": { - "description": "Time the operation was completed.", - "format": "google-datetime", - "type": "string" - }, - "createTime": { - "description": "Time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "gitlabConfig": { - "description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.", - "type": "string" - } - }, - "type": "object" - }, "UpdateWorkerPoolOperationMetadata": { "description": "Metadata for the `UpdateWorkerPool` operation.", "id": "UpdateWorkerPoolOperationMetadata", diff --git a/discovery/clouderrorreporting-v1beta1.json b/discovery/clouderrorreporting-v1beta1.json index b40667d7db9..d1e2bd947db 100644 --- a/discovery/clouderrorreporting-v1beta1.json +++ b/discovery/clouderrorreporting-v1beta1.json @@ -950,7 +950,7 @@ } } }, - "revision": "20260529", + "revision": "20260814", "rootUrl": "https://clouderrorreporting.googleapis.com/", "schemas": { "DeleteEventsResponse": { @@ -1201,7 +1201,7 @@ "type": "string" }, "message": { - "description": "Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `\"PHP (Notice|Parse error|Fatal error|Warning): \"` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack).", + "description": "Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, Go, and Rust. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `\"PHP (Notice|Parse error|Fatal error|Warning): \"` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack). * **Rust**: Must contain standard [`std::backtrace`](https://doc.rust-lang.org/std/backtrace/index.html) frames. Requires `RUST_BACKTRACE=1` and debug symbols enabled.", "type": "string" }, "serviceContext": { diff --git a/discovery/cloudidentity-v1.json b/discovery/cloudidentity-v1.json index 59786fb331b..9ff64f66f43 100644 --- a/discovery/cloudidentity-v1.json +++ b/discovery/cloudidentity-v1.json @@ -2,6 +2,12 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains": { + "description": "See and edit allowlisted domains in your Cloud Identity Organization" + }, + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly": { + "description": "See allowlisted domains in your Cloud Identity Organization" + }, "https://www.googleapis.com/auth/cloud-identity.devices": { "description": "Private Service: https://www.googleapis.com/auth/cloud-identity.devices" }, @@ -132,6 +138,112 @@ }, "protocol": "rest", "resources": { + "allowlistedDomains": { + "methods": { + "create": { + "description": "Adds a domain to the allowlist.", + "flatPath": "v1/allowlistedDomains", + "httpMethod": "POST", + "id": "cloudidentity.allowlistedDomains.create", + "parameterOrder": [], + "parameters": {}, + "path": "v1/allowlistedDomains", + "request": { + "$ref": "AllowlistedDomain" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains" + ] + }, + "delete": { + "description": "Removes a domain from the allowlist.", + "flatPath": "v1/allowlistedDomains/{allowlistedDomainsId}", + "httpMethod": "DELETE", + "id": "cloudidentity.allowlistedDomains.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to delete.", + "location": "path", + "pattern": "^allowlistedDomains/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains" + ] + }, + "get": { + "description": "Retrieves a specific domain from the allowlist.", + "flatPath": "v1/allowlistedDomains/{allowlistedDomainsId}", + "httpMethod": "GET", + "id": "cloudidentity.allowlistedDomains.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to retrieve.", + "location": "path", + "pattern": "^allowlistedDomains/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "AllowlistedDomain" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains", + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly" + ] + }, + "list": { + "description": "Lists the domains in the allowlist.", + "flatPath": "v1/allowlistedDomains", + "httpMethod": "GET", + "id": "cloudidentity.allowlistedDomains.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Optional. Provides an optional filter for list results. Currently, only exact matches on the domain are supported, such as \"domain = 'google.com'\", with no composite conditions.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Specifies the requested page size. If unspecified, the service returns at most 5000 domains. The maximum value is 5000; values above 5000 coerce to 5000. The limits can change over time.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Identifies a token from a previous page of results, if any.", + "location": "query", + "type": "string" + } + }, + "path": "v1/allowlistedDomains", + "response": { + "$ref": "ListAllowlistedDomainsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains", + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly" + ] + } + } + }, "customers": { "resources": { "userinvitations": { @@ -2311,7 +2423,7 @@ } } }, - "revision": "20260803", + "revision": "20260817", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -2336,6 +2448,22 @@ }, "type": "object" }, + "AllowlistedDomain": { + "description": "This resource object defines a domain that has been designated as allowlisted.", + "id": "AllowlistedDomain", + "properties": { + "domain": { + "description": "Required. Immutable. Name of the domain that is in the allowlist. e.g. \"google.com\"", + "type": "string" + }, + "name": { + "description": "Output only. Identifier. Resource name of the domain in the allowlist e.g. \"allowlistedDomains/0184mhaj1smlusv\"", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "CancelUserInvitationRequest": { "description": "Request to cancel sent invitation for target email in UserInvitation.", "id": "CancelUserInvitationRequest", @@ -3864,6 +3992,24 @@ }, "type": "object" }, + "ListAllowlistedDomainsResponse": { + "description": "Response message for AllowlistedDomainsService.ListAllowlistedDomains.", + "id": "ListAllowlistedDomainsResponse", + "properties": { + "allowlistedDomains": { + "description": "Contains the list of domains in the allowlist. There is no defined ordering of domains within a result.", + "items": { + "$ref": "AllowlistedDomain" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Contains the next page token if the result is not exhaustive. If there are no more results, this token is empty.", + "type": "string" + } + }, + "type": "object" + }, "ListGroupsResponse": { "description": "Response message for ListGroups operation.", "id": "ListGroupsResponse", diff --git a/discovery/cloudidentity-v1beta1.json b/discovery/cloudidentity-v1beta1.json index 0bc44d8bb58..76c4127f5cd 100644 --- a/discovery/cloudidentity-v1beta1.json +++ b/discovery/cloudidentity-v1beta1.json @@ -2,6 +2,12 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains": { + "description": "See and edit allowlisted domains in your Cloud Identity Organization" + }, + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly": { + "description": "See allowlisted domains in your Cloud Identity Organization" + }, "https://www.googleapis.com/auth/cloud-identity.devices": { "description": "Private Service: https://www.googleapis.com/auth/cloud-identity.devices" }, @@ -138,6 +144,112 @@ }, "protocol": "rest", "resources": { + "allowlistedDomains": { + "methods": { + "create": { + "description": "Adds a domain to the allowlist.", + "flatPath": "v1beta1/allowlistedDomains", + "httpMethod": "POST", + "id": "cloudidentity.allowlistedDomains.create", + "parameterOrder": [], + "parameters": {}, + "path": "v1beta1/allowlistedDomains", + "request": { + "$ref": "AllowlistedDomain" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains" + ] + }, + "delete": { + "description": "Removes a domain from the allowlist.", + "flatPath": "v1beta1/allowlistedDomains/{allowlistedDomainsId}", + "httpMethod": "DELETE", + "id": "cloudidentity.allowlistedDomains.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to delete.", + "location": "path", + "pattern": "^allowlistedDomains/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains" + ] + }, + "get": { + "description": "Retrieves a specific domain from the allowlist.", + "flatPath": "v1beta1/allowlistedDomains/{allowlistedDomainsId}", + "httpMethod": "GET", + "id": "cloudidentity.allowlistedDomains.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to retrieve.", + "location": "path", + "pattern": "^allowlistedDomains/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "AllowlistedDomain" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains", + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly" + ] + }, + "list": { + "description": "Lists the domains in the allowlist.", + "flatPath": "v1beta1/allowlistedDomains", + "httpMethod": "GET", + "id": "cloudidentity.allowlistedDomains.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Optional. Provides an optional filter for list results. Currently, only exact matches on the domain are supported, such as \"domain = 'google.com'\", with no composite conditions.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Specifies the requested page size. If unspecified, the service returns at most 5000 domains. The maximum value is 5000; values above 5000 coerce to 5000. The limits can change over time.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Identifies a token from a previous page of results, if any.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/allowlistedDomains", + "response": { + "$ref": "ListAllowlistedDomainsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains", + "https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly" + ] + } + } + }, "customers": { "resources": { "userinvitations": { @@ -2349,7 +2461,7 @@ } } }, - "revision": "20260803", + "revision": "20260817", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -2374,6 +2486,22 @@ }, "type": "object" }, + "AllowlistedDomain": { + "description": "This resource object defines a domain that has been designated as allowlisted.", + "id": "AllowlistedDomain", + "properties": { + "domain": { + "description": "Required. Immutable. Name of the domain that is in the allowlist. e.g. \"google.com\"", + "type": "string" + }, + "name": { + "description": "Output only. Identifier. Resource name of the domain in the allowlist e.g. \"allowlistedDomains/0184mhaj1smlusv\"", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "AndroidAttributes": { "description": "Resource representing the Android specific attributes of a Device.", "id": "AndroidAttributes", @@ -4778,6 +4906,24 @@ }, "type": "object" }, + "ListAllowlistedDomainsResponse": { + "description": "Response message for AllowlistedDomainsService.ListAllowlistedDomains.", + "id": "ListAllowlistedDomainsResponse", + "properties": { + "allowlistedDomains": { + "description": "Contains the list of domains in the allowlist. There is no defined ordering of domains within a result.", + "items": { + "$ref": "AllowlistedDomain" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Contains the next page token if the result is not exhaustive. If there are no more results, this token is empty.", + "type": "string" + } + }, + "type": "object" + }, "ListClientStatesResponse": { "description": "Response message that is returned in LRO result of ListClientStates Operation.", "id": "ListClientStatesResponse", diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index 1e020ff733a..a909dad43ac 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -275,7 +275,7 @@ ] }, "showEffectiveAutokeyConfig": { - "description": "Returns the effective Cloud KMS Autokey configuration for a given project or folder.", + "description": "Returns the effective Cloud KMS Autokey configuration for a given project or folder. Note on permissions: - If called on a project (`projects/{project}`), requires `cloudkms.projects.showEffectiveAutokeyConfig`. - If called on a folder (`folders/{folder}`), requires `cloudkms.folders.showEffectiveAutokeyConfig`.", "flatPath": "v1/folders/{foldersId}:showEffectiveAutokeyConfig", "httpMethod": "GET", "id": "cloudkms.folders.showEffectiveAutokeyConfig", @@ -284,7 +284,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder}", + "description": "Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for evaluating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder}", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -492,7 +492,7 @@ ] }, "showEffectiveAutokeyConfig": { - "description": "Returns the effective Cloud KMS Autokey configuration for a given project or folder.", + "description": "Returns the effective Cloud KMS Autokey configuration for a given project or folder. Note on permissions: - If called on a project (`projects/{project}`), requires `cloudkms.projects.showEffectiveAutokeyConfig`. - If called on a folder (`folders/{folder}`), requires `cloudkms.folders.showEffectiveAutokeyConfig`.", "flatPath": "v1/projects/{projectsId}:showEffectiveAutokeyConfig", "httpMethod": "GET", "id": "cloudkms.projects.showEffectiveAutokeyConfig", @@ -501,7 +501,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder}", + "description": "Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for evaluating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder}", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -3063,7 +3063,7 @@ } } }, - "revision": "20260806", + "revision": "20260814", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AddQuorumMember": { @@ -3280,7 +3280,7 @@ "type": "object" }, "AutokeyConfig": { - "description": "Cloud KMS Autokey configuration for a folder.", + "description": "Cloud KMS Autokey configuration for a project or folder.", "id": "AutokeyConfig", "properties": { "etag": { @@ -4340,7 +4340,7 @@ "id": "ExternalProtectionLevelOptions", "properties": { "ekmConnectionBackendOverride": { - "description": "Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`.", + "description": "Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the crypto_key_backend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`.", "type": "string" }, "ekmConnectionKeyPath": { @@ -4933,12 +4933,14 @@ "enum": [ "ATTESTATION_FORMAT_UNSPECIFIED", "CAVIUM_V1_COMPRESSED", - "CAVIUM_V2_COMPRESSED" + "CAVIUM_V2_COMPRESSED", + "CAVIUM_V209" ], "enumDescriptions": [ "Not specified.", "Cavium HSM attestation compressed with gzip. Note that this format is defined by Cavium and subject to change at any time. See https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html.", - "Cavium HSM attestation V2 compressed with gzip. This is a new format introduced in Cavium's version 3.2-08." + "Cavium HSM attestation V2 compressed with gzip. This is a new format introduced in Cavium's version 3.2-08.", + "Cavium HSM attestation V209, introduced in Cavium's version 2.09-0702." ], "readOnly": true, "type": "string" @@ -6045,7 +6047,7 @@ "type": "object" }, "ShowEffectiveAutokeyConfigResponse": { - "description": "Response message for ShowEffectiveAutokeyConfig.", + "description": "Response message for ShowEffectiveAutokeyConfig", "id": "ShowEffectiveAutokeyConfigResponse", "properties": { "keyProject": { diff --git a/discovery/cloudnumberregistry-v1alpha.json b/discovery/cloudnumberregistry-v1alpha.json index 03c4e802184..318548bc14d 100644 --- a/discovery/cloudnumberregistry-v1alpha.json +++ b/discovery/cloudnumberregistry-v1alpha.json @@ -105,6 +105,285 @@ }, "protocol": "rest", "resources": { + "organizations": { + "resources": { + "locations": { + "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": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "cloudnumberregistry.organizations.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.organizations.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.organizations.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "cloudnumberregistry.organizations.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": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "orgNumberRegistries": { + "methods": { + "create": { + "description": "Creates a new OrgNumberRegistry in a given organization and location.", + "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgNumberRegistries", + "httpMethod": "POST", + "id": "cloudnumberregistry.organizations.locations.orgNumberRegistries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "orgNumberRegistryId": { + "description": "Required. The ID to use for the OrgNumberRegistry, which will become the final segment of the resource name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name where the OrgNumberRegistry will be created.", + "location": "path", + "pattern": "^organizations/[^/]+/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 after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/orgNumberRegistries", + "request": { + "$ref": "OrgNumberRegistry" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single OrgNumberRegistry.", + "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgNumberRegistries/{orgNumberRegistriesId}", + "httpMethod": "DELETE", + "id": "cloudnumberregistry.organizations.locations.orgNumberRegistries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the OrgNumberRegistry to delete.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/orgNumberRegistries/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single OrgNumberRegistry.", + "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgNumberRegistries/{orgNumberRegistriesId}", + "httpMethod": "GET", + "id": "cloudnumberregistry.organizations.locations.orgNumberRegistries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the OrgNumberRegistry to retrieve.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/orgNumberRegistries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "OrgNumberRegistry" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists OrgNumberRegistries in a given organization and location.", + "flatPath": "v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgNumberRegistries", + "httpMethod": "GET", + "id": "cloudnumberregistry.organizations.locations.orgNumberRegistries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression to filter the results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name, for example `organizations/*/locations/*`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/orgNumberRegistries", + "response": { + "$ref": "ListOrgNumberRegistriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "projects": { "resources": { "locations": { @@ -1456,7 +1735,7 @@ } } }, - "revision": "20260708", + "revision": "20260819", "rootUrl": "https://cloudnumberregistry.googleapis.com/", "schemas": { "AggregatedData": { @@ -2015,6 +2294,31 @@ }, "type": "object" }, + "ListOrgNumberRegistriesResponse": { + "description": "Response message for the CloudNumberRegistry.ListOrgNumberRegistries method.", + "id": "ListOrgNumberRegistriesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "orgNumberRegistries": { + "description": "The list of OrgNumberRegistries.", + "items": { + "$ref": "OrgNumberRegistry" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListRealmsResponse": { "description": "Response message for the CloudNumberRegistry.ListRealms method.", "id": "ListRealmsResponse", @@ -2178,6 +2482,47 @@ }, "type": "object" }, + "OrgNumberRegistry": { + "description": "An OrgNumberRegistry defines a delegation of authority from an organization to a project, allowing the project to manage IP address data within specified scopes of the organization.", + "id": "OrgNumberRegistry", + "properties": { + "adminProject": { + "description": "Required. The project that will act as the admin project for CNR resources Format: projects/{project_number} or projects/{project_id}", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which the OrgNumberRegistry was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User-defined labels.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the OrgNumberRegistry.", + "type": "string" + }, + "targetScopes": { + "description": "Required. The scopes within the organization that the project is able to manage. Currently only organization scope is supported. For example, \"organizations/1234567890\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. The time at which the OrgNumberRegistry was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Range": { "description": "Represents either a CustomRange or a DiscoveredRange.", "id": "Range", diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 5c4a8d3fb68..b9784beed2d 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -6236,7 +6236,7 @@ } } }, - "revision": "20260813", + "revision": "20260818", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudCesV1mainAgentTransfer": { @@ -9834,9 +9834,17 @@ "id": "GoogleCloudContactcenterinsightsV1GcsSource", "properties": { "audioUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation audio.", + "deprecated": true, + "description": "Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" }, + "audioUris": { + "description": "Immutable. Cloud Storage URIs that point to files that contain the conversation audio. Supports both single audio files and multi-leg session recordings (e.g., call transfers, rolling recording buffers).", + "items": { + "type": "string" + }, + "type": "array" + }, "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" @@ -13133,6 +13141,14 @@ "description": "The signed URI for the audio from the Cloud Storage conversation source.", "type": "string" }, + "signedGcsAudioUris": { + "description": "Output only. The signed URIs for the audio from the Cloud Storage conversation source when multiple audio files exist (e.g. multi-leg conversations).", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "signedTurnLevelAudios": { "description": "The signed URI for the audio corresponding to each turn in the conversation.", "items": { @@ -15875,9 +15891,17 @@ "id": "GoogleCloudContactcenterinsightsV1alpha1GcsSource", "properties": { "audioUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation audio.", + "deprecated": true, + "description": "Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" }, + "audioUris": { + "description": "Immutable. Cloud Storage URIs that point to files that contain the conversation audio. Supports both single audio files and multi-leg session recordings (e.g., call transfers, rolling recording buffers).", + "items": { + "type": "string" + }, + "type": "array" + }, "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" @@ -20466,9 +20490,17 @@ "id": "GoogleCloudContactcenterinsightsV1mainGcsSource", "properties": { "audioUri": { - "description": "Cloud Storage URI that points to a file that contains the conversation audio.", + "deprecated": true, + "description": "Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio.", "type": "string" }, + "audioUris": { + "description": "Immutable. Cloud Storage URIs that point to files that contain the conversation audio. Supports both single audio files and multi-leg session recordings (e.g., call transfers, rolling recording buffers).", + "items": { + "type": "string" + }, + "type": "array" + }, "transcriptUri": { "description": "Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.", "type": "string" diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index af686f09af3..de94528fce4 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -1715,7 +1715,7 @@ } } }, - "revision": "20260805", + "revision": "20260812", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -4033,6 +4033,10 @@ "description": "Required. Where should the files be placed on the worker.", "type": "string" }, + "fetchTags": { + "description": "Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags.", + "type": "boolean" + }, "recurseSubmodules": { "description": "Optional. True if submodules should be fetched too (default false).", "type": "boolean" diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index c29bc626103..ca1da20580e 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -1454,7 +1454,7 @@ } } }, - "revision": "20260805", + "revision": "20260812", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -3571,6 +3571,10 @@ "description": "Required. Where should the files be placed on the worker.", "type": "string" }, + "fetchTags": { + "description": "Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags.", + "type": "boolean" + }, "recurseSubmodules": { "description": "Optional. True if submodules should be fetched too (default false).", "type": "boolean" diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index d52a28a5273..9278aaea2d6 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -1771,7 +1771,7 @@ } } }, - "revision": "20260805", + "revision": "20260812", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -3947,6 +3947,10 @@ "description": "Required. Where should the files be placed on the worker.", "type": "string" }, + "fetchTags": { + "description": "Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags.", + "type": "boolean" + }, "recurseSubmodules": { "description": "Optional. True if submodules should be fetched too (default false).", "type": "boolean" diff --git a/discovery/datacatalog-v1.json b/discovery/datacatalog-v1.json index c8e76911e4e..210ad78009b 100644 --- a/discovery/datacatalog-v1.json +++ b/discovery/datacatalog-v1.json @@ -2344,7 +2344,7 @@ } } }, - "revision": "20260211", + "revision": "20260706", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -3173,7 +3173,9 @@ "FEATURE_ONLINE_STORE", "FEATURE_VIEW", "FEATURE_GROUP", - "GRAPH" + "GRAPH", + "NODE", + "EDGE" ], "enumDescriptions": [ "Default unknown type.", @@ -3195,7 +3197,9 @@ "Feature Online Store resource in Vertex AI Feature Store.", "Feature View resource in Vertex AI Feature Store.", "Feature Group resource in Vertex AI Feature Store.", - "An entry type for a graph." + "An entry type for a graph.", + "An entry type for a graph node.", + "An entry type for a graph edge." ], "type": "string" }, diff --git a/discovery/datacatalog-v1beta1.json b/discovery/datacatalog-v1beta1.json index f3f6399f478..5fc43e6233f 100644 --- a/discovery/datacatalog-v1beta1.json +++ b/discovery/datacatalog-v1beta1.json @@ -1855,7 +1855,7 @@ } } }, - "revision": "20260211", + "revision": "20260706", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2673,7 +2673,9 @@ "FEATURE_ONLINE_STORE", "FEATURE_VIEW", "FEATURE_GROUP", - "GRAPH" + "GRAPH", + "NODE", + "EDGE" ], "enumDescriptions": [ "Default unknown type.", @@ -2695,7 +2697,9 @@ "Feature Online Store resource in Vertex AI Feature Store.", "Feature View resource in Vertex AI Feature Store.", "Feature Group resource in Vertex AI Feature Store.", - "An entry type for a graph." + "An entry type for a graph.", + "An entry type for a graph node.", + "An entry type for a graph edge." ], "type": "string" }, diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json index df351a52091..3efb2358c7d 100644 --- a/discovery/dataform-v1beta1.json +++ b/discovery/dataform-v1beta1.json @@ -2148,6 +2148,35 @@ }, "workspaces": { "methods": { + "checkout": { + "description": "Checkout a branch in a Workspace.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:checkout", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.checkout", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:checkout", + "request": { + "$ref": "CheckoutWorkspaceBranchRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "commit": { "description": "Applies a Git commit for uncommitted files in a Workspace.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:commit", @@ -2237,6 +2266,115 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "deleteBranch": { + "description": "Deletes a branch in a Workspace.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:deleteBranch", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.deleteBranch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:deleteBranch", + "request": { + "$ref": "DeleteBranchRequest" + }, + "response": { + "$ref": "DeleteBranchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchBranches": { + "description": "Fetches branches in a Workspace.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchBranches", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.fetchBranches", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "Optional. Filter for the returned list.", + "enum": [ + "BRANCH_FILTER_UNSPECIFIED", + "LOCAL_ONLY", + "REMOTE_ONLY", + "ALL" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Returns local branches.", + "Returns remote branches.", + "Returns all branches." + ], + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of branches to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `FetchWorkspaceBranches` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchWorkspaceBranches`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:fetchBranches", + "response": { + "$ref": "FetchWorkspaceBranchesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchCurrentBranch": { + "description": "Fetches the current branch of a Workspace.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchCurrentBranch", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.fetchCurrentBranch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:fetchCurrentBranch", + "response": { + "$ref": "FetchCurrentWorkspaceBranchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "fetchFileDiff": { "description": "Fetches Git diff for an uncommitted file in a Workspace.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchFileDiff", @@ -2855,6 +2993,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "syncWorkspaceRefs": { + "description": "Syncs the refs of a Workspace.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:syncWorkspaceRefs", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.syncWorkspaceRefs", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:syncWorkspaceRefs", + "request": { + "$ref": "SyncWorkspaceRefsRequest" + }, + "response": { + "$ref": "SyncWorkspaceRefsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:testIamPermissions", @@ -3261,7 +3428,7 @@ } } }, - "revision": "20260802", + "revision": "20260819", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -3415,6 +3582,21 @@ }, "type": "object" }, + "BranchMetadata": { + "description": "Contains metadata about a branch.", + "id": "BranchMetadata", + "properties": { + "branchName": { + "description": "The branch name.", + "type": "string" + }, + "lastCommit": { + "$ref": "CommitLogEntry", + "description": "The last commit on the branch." + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -3433,6 +3615,25 @@ "properties": {}, "type": "object" }, + "CheckoutWorkspaceBranchRequest": { + "description": "`CheckoutWorkspaceBranch` request message.", + "id": "CheckoutWorkspaceBranchRequest", + "properties": { + "branch": { + "description": "Required. The name of the branch in the Git repository to which the workspace should be checked out.", + "type": "string" + }, + "createIfNotExists": { + "description": "Optional. If set to true and the branch does not exist, it will be created. Otherwise, an error will be thrown.", + "type": "boolean" + }, + "sourceBranch": { + "description": "Optional. The name of the branch in the Git repository from which the new branch should be created. If left unset, the workspace's current branch name will be used. Accepts only branch names from FetchWorkspaceBranches response, and can only be set if `create_if_not_exists` is true. Oherwise, an error will be thrown.", + "type": "string" + } + }, + "type": "object" + }, "CodeCompilationConfig": { "description": "Configures various aspects of Dataform code compilation.", "id": "CodeCompilationConfig", @@ -3900,6 +4101,27 @@ }, "type": "object" }, + "DeleteBranchRequest": { + "description": "`DeleteBranch` request message.", + "id": "DeleteBranchRequest", + "properties": { + "branch": { + "description": "Required. The name of the branch in the Git repository to delete.", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any non-pushed commits on the branch will be deleted. Upstream branch name will be the same as the branch to delete.", + "type": "boolean" + } + }, + "type": "object" + }, + "DeleteBranchResponse": { + "description": "`DeleteBranch` response message.", + "id": "DeleteBranchResponse", + "properties": {}, + "type": "object" + }, "DeleteFile": { "description": "Represents the delete file operation.", "id": "DeleteFile", @@ -4014,6 +4236,17 @@ }, "type": "object" }, + "FetchCurrentWorkspaceBranchResponse": { + "description": "Response message for `FetchCurrentWorkspaceBranch` method.", + "id": "FetchCurrentWorkspaceBranchResponse", + "properties": { + "branchName": { + "description": "The name of the current branch for the workspace.", + "type": "string" + } + }, + "type": "object" + }, "FetchFileDiffResponse": { "description": "`FetchFileDiff` response message.", "id": "FetchFileDiffResponse", @@ -4088,6 +4321,24 @@ }, "type": "object" }, + "FetchWorkspaceBranchesResponse": { + "description": "Response message for `FetchWorkspaceBranches` method.", + "id": "FetchWorkspaceBranchesResponse", + "properties": { + "branches": { + "description": "The branches in the workspace.", + "items": { + "$ref": "BranchMetadata" + }, + "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" + }, "FileOperation": { "description": "Represents a single file operation to the repository.", "id": "FileOperation", @@ -5735,6 +5986,28 @@ }, "type": "object" }, + "SyncWorkspaceRefsRequest": { + "description": "`SyncWorkspaceRefs` request message.", + "id": "SyncWorkspaceRefsRequest", + "properties": { + "deepen": { + "description": "Optional. Can be used to deepen the commit history of shallow clones. Git documentation: https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---deependepth", + "format": "int32", + "type": "integer" + }, + "remoteBranchName": { + "description": "Optional. The name of the branch in the Git remote to which the refs should be fetched for. If left unset, all remote branches will be fetched.", + "type": "string" + } + }, + "type": "object" + }, + "SyncWorkspaceRefsResponse": { + "description": "`SyncWorkspaceRefs` response message.", + "id": "SyncWorkspaceRefsResponse", + "properties": {}, + "type": "object" + }, "TableUpdateTrigger": { "description": "Represents a table update trigger configuration.", "id": "TableUpdateTrigger", @@ -6193,10 +6466,19 @@ "description": "Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.", "readOnly": true }, + "depth": { + "description": "Optional. Input only. Immutable. The maximum depth of the Git repository to checkout for this workspace. If defined and greater than 0, the Git repository will be created as a shallow clone with the given depth, otherwise a full clone will be performed. This field is available only for GitHub, Gitlab and 1p repositories with enabled branch management.", + "format": "int32", + "type": "integer" + }, "disableMoves": { "description": "Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.", "type": "boolean" }, + "enableBranchManagement": { + "description": "Immutable. Controls the enablement of branch checkout for the workspace. When set to True, the workspace will be allowed to checkout branches.", + "type": "boolean" + }, "internalMetadata": { "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", "readOnly": true, @@ -6206,10 +6488,19 @@ "description": "Identifier. The workspace's name.", "type": "string" }, + "originalBranch": { + "description": "Optional. Input only. Immutable. The name of the default upstream branch for all pull/push operations in the remote repository for this workspace. If empty, the HEAD branch from repository will be used.", + "type": "string" + }, "privateResourceMetadata": { "$ref": "PrivateResourceMetadata", "description": "Output only. Metadata indicating whether this resource is user-scoped. For `Workspace` resources, the `user_scoped` field is always `true`.", "readOnly": true + }, + "shallow": { + "description": "Output only. If set to true, the workspace was created as a shallow clone. Will be set to true if the depth field is set to a value greater than 0, otherwise it will be set to false.", + "readOnly": true, + "type": "boolean" } }, "type": "object" diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json index 53d9cd43e9f..45ca9568719 100644 --- a/discovery/developerconnect-v1.json +++ b/discovery/developerconnect-v1.json @@ -1800,7 +1800,7 @@ } } }, - "revision": "20260611", + "revision": "20260813", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -3418,7 +3418,8 @@ "ROVO", "NEW_RELIC", "DATASTAX", - "DYNATRACE" + "DYNATRACE", + "BITBUCKET_CLOUD" ], "enumDescriptions": [ "No system provider specified.", @@ -3429,7 +3430,8 @@ "Rovo provider. Must select the \"rovo\" scope.", "New Relic provider. No scopes are allowed.", "Datastax provider. No scopes are allowed.", - "Dynatrace provider." + "Dynatrace provider.", + "Bitbucket Cloud provider." ], "type": "string" } @@ -3558,7 +3560,8 @@ "ROVO", "NEW_RELIC", "DATASTAX", - "DYNATRACE" + "DYNATRACE", + "BITBUCKET_CLOUD" ], "enumDescriptions": [ "No system provider specified.", @@ -3569,7 +3572,8 @@ "Rovo provider. Must select the \"rovo\" scope.", "New Relic provider. No scopes are allowed.", "Datastax provider. No scopes are allowed.", - "Dynatrace provider." + "Dynatrace provider.", + "Bitbucket Cloud provider." ], "type": "string" }, diff --git a/discovery/developerknowledge-v1.json b/discovery/developerknowledge-v1.json index 29a0f837ff1..214ff7ae741 100644 --- a/discovery/developerknowledge-v1.json +++ b/discovery/developerknowledge-v1.json @@ -250,7 +250,7 @@ } } }, - "revision": "20260809", + "revision": "20260817", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { "Answer": { @@ -456,6 +456,12 @@ "description": "Output only. Contains the resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`", "readOnly": true, "type": "string" + }, + "relevanceScore": { + "description": "Output only. Represents the relevance score of the chunk to the search query. Higher score indicates higher chunk relevance. The score is in range [0.0, 1.0].", + "format": "double", + "readOnly": true, + "type": "number" } }, "type": "object" diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 51aa7bae9bf..018734b1fb6 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -8780,7 +8780,7 @@ } } }, - "revision": "20260808", + "revision": "20260815", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -13665,6 +13665,7 @@ "type": "object" }, "GoogleCloudDialogflowV2CesAppSpec": { + "deprecated": true, "id": "GoogleCloudDialogflowV2CesAppSpec", "properties": { "cesApp": { @@ -15337,6 +15338,7 @@ "$ref": "GoogleCloudDialogflowV2AgentCoachingContext" }, "cesAppSpecs": { + "deprecated": true, "items": { "$ref": "GoogleCloudDialogflowV2CesAppSpec" }, @@ -20213,6 +20215,9 @@ "properties": { "message": { "type": "string" + }, + "retryable": { + "type": "boolean" } }, "type": "object" @@ -23522,6 +23527,9 @@ "properties": { "message": { "type": "string" + }, + "retryable": { + "type": "boolean" } }, "type": "object" diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index f4b46edeae8..7b64df34c6d 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -8431,7 +8431,7 @@ } } }, - "revision": "20260808", + "revision": "20260815", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -15167,6 +15167,9 @@ "properties": { "message": { "type": "string" + }, + "retryable": { + "type": "boolean" } }, "type": "object" @@ -16130,6 +16133,7 @@ "type": "object" }, "GoogleCloudDialogflowV2beta1CesAppSpec": { + "deprecated": true, "id": "GoogleCloudDialogflowV2beta1CesAppSpec", "properties": { "cesApp": { @@ -17534,6 +17538,7 @@ "$ref": "GoogleCloudDialogflowV2beta1AgentCoachingContext" }, "cesAppSpecs": { + "deprecated": true, "items": { "$ref": "GoogleCloudDialogflowV2beta1CesAppSpec" }, @@ -22942,6 +22947,9 @@ "properties": { "message": { "type": "string" + }, + "retryable": { + "type": "boolean" } }, "type": "object" diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 24f3f879cb9..08a50c5bbc4 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -5031,7 +5031,7 @@ } } }, - "revision": "20260808", + "revision": "20260815", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { @@ -15985,6 +15985,9 @@ "properties": { "message": { "type": "string" + }, + "retryable": { + "type": "boolean" } }, "type": "object" @@ -18985,6 +18988,9 @@ "properties": { "message": { "type": "string" + }, + "retryable": { + "type": "boolean" } }, "type": "object" diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index 79109ad9d56..f65a307b0e9 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -5151,7 +5151,7 @@ } } }, - "revision": "20260808", + "revision": "20260815", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -17030,6 +17030,9 @@ "properties": { "message": { "type": "string" + }, + "retryable": { + "type": "boolean" } }, "type": "object" @@ -20030,6 +20033,9 @@ "properties": { "message": { "type": "string" + }, + "retryable": { + "type": "boolean" } }, "type": "object" diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index 52f36cd6b93..c3ce71a2e33 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20260809", + "revision": "20260816", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -372,6 +372,20 @@ "deprecated": true, "description": "Optional. Deprecated: Use top-level `language_codes` instead. Specifies one or more languages in the audio." }, + "mode": { + "description": "Optional. Configures transcription mode. Supported values: `VERBATIM`, `SMART`. If unspecified, defaults to `VERBATIM` transcription. In `SMART` mode, the model performs disfluency removal (eliminating filler words, repetitions, and false starts), light grammatical cleanup, automatic formatting (paragraphs, bullet points, numbered lists), and minor user edits (inline self-corrections). Timestamps and diarization are incompatible with mode `SMART`.", + "enum": [ + "MODE_UNSPECIFIED", + "VERBATIM", + "SMART" + ], + "enumDescriptions": [ + "Unspecified transcription mode.", + "Verbatim transcription mode.", + "Smart transcription mode." + ], + "type": "string" + }, "wordTimestamp": { "description": "Optional. Configures word-level timestamp generation.", "type": "boolean" @@ -2386,6 +2400,20 @@ "$ref": "GoogleCloudAiplatformV1beta1Blob", "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request." }, + "mediaProcessing": { + "description": "Optional. How the model processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field.", + "enum": [ + "MEDIA_PROCESSING_UNSPECIFIED", + "STATIC", + "AGENTIC" + ], + "enumDescriptions": [ + "Default. Uses model-specific processing (3.5 Pro+ -> `AGENTIC`, older models -> `STATIC`).", + "Fixed-rate frame extraction. All frames placed in context.", + "Model-driven dynamic navigation. Recommended for most use cases." + ], + "type": "string" + }, "mediaResolution": { "$ref": "GoogleCloudAiplatformV1beta1PartMediaResolution", "description": "per part media resolution. Media resolution for the input media." diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index cf8ffe0e6b7..d1008531f06 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1014,6 +1014,127 @@ } } }, + "changeStreams": { + "methods": { + "create": { + "description": "Creates a new change stream for the database.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/changeStreams", + "httpMethod": "POST", + "id": "firestore.projects.databases.changeStreams.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "changeStreamId": { + "description": "Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value should be 4-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character must be a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent database to create the change stream for. Format is `projects/{project}/databases/{database}`.", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/changeStreams", + "request": { + "$ref": "GoogleFirestoreAdminV1ChangeStream" + }, + "response": { + "$ref": "GoogleFirestoreAdminV1ChangeStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, + "delete": { + "description": "Deletes a change stream.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/changeStreams/{changeStreamsId}", + "httpMethod": "DELETE", + "id": "firestore.projects.databases.changeStreams.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The etag of the change stream to delete. If this is not the current etag of the change stream, the deletion will fail.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the change stream to delete. Format is `projects/{project}/databases/{database}/changeStreams/{change_stream}`.", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+/changeStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, + "get": { + "description": "Gets information about a change stream.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/changeStreams/{changeStreamsId}", + "httpMethod": "GET", + "id": "firestore.projects.databases.changeStreams.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the change stream to retrieve. Format is `projects/{project}/databases/{database}/changeStreams/{change_stream}`.", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+/changeStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleFirestoreAdminV1ChangeStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + }, + "list": { + "description": "Lists all change streams in a database.", + "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/changeStreams", + "httpMethod": "GET", + "id": "firestore.projects.databases.changeStreams.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent database to list change streams from. Format is `projects/{project}/databases/{database}`.", + "location": "path", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/changeStreams", + "response": { + "$ref": "GoogleFirestoreAdminV1ListChangeStreamsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ] + } + } + }, "collectionGroups": { "resources": { "fields": { @@ -1403,6 +1524,12 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/.*$", "required": true, "type": "string" + }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" } }, "path": "v1/{+parent}/{collectionId}", @@ -1443,6 +1570,12 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$", "required": true, "type": "string" + }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" } }, "path": "v1/{+name}", @@ -1511,6 +1644,12 @@ "location": "query", "type": "string" }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" + }, "transaction": { "description": "Reads the document in a transaction.", "format": "byte", @@ -1583,6 +1722,12 @@ "location": "query", "type": "boolean" }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" + }, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1689,6 +1834,12 @@ "location": "query", "type": "boolean" }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" + }, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1801,6 +1952,12 @@ "required": true, "type": "string" }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" + }, "updateMask.fieldPaths": { "description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.", "location": "query", @@ -2445,7 +2602,7 @@ } } }, - "revision": "20260706", + "revision": "20260810", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2534,6 +2691,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "transaction": { "description": "Reads documents in a transaction.", "format": "byte", @@ -2578,6 +2739,10 @@ "description": "Labels associated with this batch write.", "type": "object" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "writes": { "description": "The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.", "items": { @@ -2616,6 +2781,10 @@ "options": { "$ref": "TransactionOptions", "description": "The options for the transaction. Defaults to a read-write transaction." + }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." } }, "type": "object" @@ -2684,6 +2853,10 @@ "description": "The request for Firestore.Commit.", "id": "CommitRequest", "properties": { + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "transaction": { "description": "If set, applies all writes in this transaction, and commits it.", "format": "byte", @@ -2948,6 +3121,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "structuredPipeline": { "$ref": "StructuredPipeline", "description": "A pipelined operation." @@ -2961,7 +3138,7 @@ "type": "object" }, "ExecutePipelineResponse": { - "description": "The response for Firestore.Execute.", + "description": "The response for Firestore.ExecutePipeline.", "id": "ExecutePipelineResponse", "properties": { "executionTime": { @@ -3461,6 +3638,52 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1ChangeStream": { + "description": "A Change Stream is a resource that allows users to receive change notifications from a Firestore database.", + "id": "GoogleFirestoreAdminV1ChangeStream", + "properties": { + "collectionGroupScope": { + "$ref": "GoogleFirestoreAdminV1CollectionGroupScope", + "description": "If set, the change stream is scoped to a collection group." + }, + "createTime": { + "description": "Output only. The time the Change Stream was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "databaseScope": { + "$ref": "GoogleFirestoreAdminV1DatabaseScope", + "description": "If set, the change stream is scoped to the entire database." + }, + "etag": { + "description": "Optional. An etag used to determine which version of the configuration is being edited.", + "type": "string" + }, + "name": { + "description": "Identifier. The external resource name of the change stream. Format `projects/{project}/databases/{database}/changeStreams/{change_stream}`", + "type": "string" + }, + "retentionPeriod": { + "description": "Required. The retention period of the change stream. This is the amount of time a change event is available on the change stream. Must be from 1 to 7 days, inclusive. The retention_period must be in day granularity, i.e. it must be a multiple of 24 hours.", + "format": "google-duration", + "type": "string" + }, + "startTime": { + "description": "Output only. The time the Change Stream started recording events.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the Change Stream was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1CloneDatabaseMetadata": { "description": "Metadata for the long-running operation from the CloneDatabase request.", "id": "GoogleFirestoreAdminV1CloneDatabaseMetadata", @@ -3559,6 +3782,17 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1CollectionGroupScope": { + "description": "The change stream is scoped to a collection group. Only events associated with the given collection group are visible to the Change Stream. Only a single change stream can be enabled per collection group.", + "id": "GoogleFirestoreAdminV1CollectionGroupScope", + "properties": { + "collectionGroupId": { + "description": "Required. The collection group name.", + "type": "string" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1CreateDatabaseMetadata": { "description": "Metadata related to the create database operation.", "id": "GoogleFirestoreAdminV1CreateDatabaseMetadata", @@ -3614,8 +3848,8 @@ ], "enumDescriptions": [ "Not used.", - "Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Enterprise Edition databases.", - "Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Standard Edition databases.", + "Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Enterprise edition databases.", + "Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore Standard edition databases.", "Use optimistic concurrency control with entity groups by default. This mode is enabled for some databases that were automatically upgraded from Cloud Datastore to Cloud Firestore with Datastore Mode. It is not recommended for any new databases, and not supported for Firestore Native databases." ], "type": "string" @@ -3671,7 +3905,7 @@ "type": "string" }, "firestoreDataAccessMode": { - "description": "Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.", + "description": "Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard edition.", "enum": [ "DATA_ACCESS_MODE_UNSPECIFIED", "DATA_ACCESS_MODE_ENABLED", @@ -3699,7 +3933,7 @@ "type": "string" }, "mongodbCompatibleDataAccessMode": { - "description": "Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition.", + "description": "Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard edition.", "enum": [ "DATA_ACCESS_MODE_UNSPECIFIED", "DATA_ACCESS_MODE_ENABLED", @@ -3795,6 +4029,12 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1DatabaseScope": { + "description": "The change stream is scoped to the entire database. All events in the database are visible to the Change Stream. One Database scope Change Stream is allowed per database.", + "id": "GoogleFirestoreAdminV1DatabaseScope", + "properties": {}, + "type": "object" + }, "GoogleFirestoreAdminV1DeleteDatabaseMetadata": { "description": "Metadata related to the delete database operation.", "id": "GoogleFirestoreAdminV1DeleteDatabaseMetadata", @@ -4133,7 +4373,7 @@ "type": "object" }, "GoogleFirestoreAdminV1Index": { - "description": "Cloud Firestore indexes enable simple and complex queries against documents in a database.", + "description": "Cloud Firestore indexes enable simple and complex queries against documents in a database. In Standard edition databases, single-field indexes are managed using the google.firestore.admin.v1.Field resource, and composite indexes are managed using the google.firestore.admin.v1.Index resource. In Enterprise edition databases, both single-field and composite indexes are managed using the google.firestore.admin.v1.Index resource.", "id": "GoogleFirestoreAdminV1Index", "properties": { "apiScope": { @@ -4160,14 +4400,14 @@ ], "enumDescriptions": [ "Unspecified. It will use database default setting. This value is input only.", - "An index entry will only exist if ALL fields are present in the document. This is both the default and only allowed value for Standard Edition databases (for both Cloud Firestore `ANY_API` and Cloud Datastore `DATASTORE_MODE_API`). Take for example the following document: ``` { \"__name__\": \"...\", \"a\": 1, \"b\": 2, \"c\": 3 } ``` an index on `(a ASC, b ASC, c ASC, __name__ ASC)` will generate an index entry for this document since `a`, 'b', `c`, and `__name__` are all present but an index of `(a ASC, d ASC, __name__ ASC)` will not generate an index entry for this document since `d` is missing. This means that such indexes can only be used to serve a query when the query has either implicit or explicit requirements that all fields from the index are present.", - "An index entry will exist if ANY field are present in the document. This is used as the definition of a sparse index for Enterprise Edition databases. Take for example the following document: ``` { \"__name__\": \"...\", \"a\": 1, \"b\": 2, \"c\": 3 } ``` an index on `(a ASC, d ASC)` will generate an index entry for this document since `a` is present, and will fill in an `unset` value for `d`. An index on `(d ASC, e ASC)` will not generate any index entry as neither `d` nor `e` are present. An index that contains `__name__` will generate an index entry for all documents since Firestore guarantees that all documents have a `__name__` field.", - "An index entry will exist regardless of if the fields are present or not. This is the default density for an Enterprise Edition database. The index will store `unset` values for fields that are not present in the document." + "An index entry will only exist if ALL fields are present in the document. This is both the default and only allowed value for Standard edition databases (for both Cloud Firestore `ANY_API` and Cloud Datastore `DATASTORE_MODE_API`). Take for example the following document: ``` { \"__name__\": \"...\", \"a\": 1, \"b\": 2, \"c\": 3 } ``` an index on `(a ASC, b ASC, c ASC, __name__ ASC)` will generate an index entry for this document since `a`, 'b', `c`, and `__name__` are all present but an index of `(a ASC, d ASC, __name__ ASC)` will not generate an index entry for this document since `d` is missing. This means that such indexes can only be used to serve a query when the query has either implicit or explicit requirements that all fields from the index are present.", + "An index entry will exist if ANY field are present in the document. This is used as the definition of a sparse index for Enterprise edition databases. Take for example the following document: ``` { \"__name__\": \"...\", \"a\": 1, \"b\": 2, \"c\": 3 } ``` an index on `(a ASC, d ASC)` will generate an index entry for this document since `a` is present, and will fill in an `unset` value for `d`. An index on `(d ASC, e ASC)` will not generate any index entry as neither `d` nor `e` are present. An index that contains `__name__` will generate an index entry for all documents since Firestore guarantees that all documents have a `__name__` field.", + "An index entry will exist regardless of if the fields are present or not. This is the default density for an Enterprise edition database. The index will store `unset` values for fields that are not present in the document." ], "type": "string" }, "fields": { - "description": "The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.", + "description": "The fields supported by this index. At most 100 fields may be specified. In Standard edition databases only: - At least 2 fields must be specified. - The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in the index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified).", "items": { "$ref": "GoogleFirestoreAdminV1IndexField" }, @@ -4178,7 +4418,7 @@ "type": "boolean" }, "name": { - "description": "Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.", + "description": "A server-defined name for this index. Output only. When used in the google.firestore.admin.v1.Index resource, the value is of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` When used in the google.firestore.admin.v1.Field resource, the value is empty.", "type": "string" }, "queryScope": { @@ -4413,6 +4653,20 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1ListChangeStreamsResponse": { + "description": "Response to FirestoreAdmin.ListChangeStreams.", + "id": "GoogleFirestoreAdminV1ListChangeStreamsResponse", + "properties": { + "changeStreams": { + "description": "The list of change streams.", + "items": { + "$ref": "GoogleFirestoreAdminV1ChangeStream" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1ListDatabasesResponse": { "description": "The list of databases for a project.", "id": "GoogleFirestoreAdminV1ListDatabasesResponse", @@ -4816,7 +5070,42 @@ "GoogleFirestoreAdminV1UpdateDatabaseMetadata": { "description": "Metadata related to the update database operation.", "id": "GoogleFirestoreAdminV1UpdateDatabaseMetadata", - "properties": {}, + "properties": { + "endTime": { + "description": "The time this operation completed. Will be unset if operation still in progress.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "The time this operation started.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The state of the operation.", + "enum": [ + "OPERATION_STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "CANCELLING", + "FINALIZING", + "SUCCESSFUL", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified.", + "Request is being prepared for processing.", + "Request is actively being processed.", + "Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.", + "Request has been processed and is in its finalization stage.", + "Request has completed successfully.", + "Request has finished being processed, but encountered an error.", + "Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation." + ], + "type": "string" + } + }, "type": "object" }, "GoogleFirestoreAdminV1UserCreds": { @@ -5013,6 +5302,10 @@ "description": "Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", "format": "google-datetime", "type": "string" + }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." } }, "type": "object" @@ -5090,6 +5383,10 @@ "description": "The ID of a target to remove from this stream.", "format": "int32", "type": "integer" + }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for the request." } }, "type": "object" @@ -5217,6 +5514,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for the request." + }, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported." @@ -5357,10 +5658,28 @@ }, "type": "object" }, + "RequestOptions": { + "description": "Options for a server request.", + "id": "RequestOptions", + "properties": { + "requestTags": { + "description": "Optional. The request tags for the request.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "RollbackRequest": { "description": "The request for Firestore.Rollback.", "id": "RollbackRequest", "properties": { + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "transaction": { "description": "Required. The transaction to roll back.", "format": "byte", @@ -5386,6 +5705,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for the request." + }, "structuredAggregationQuery": { "$ref": "StructuredAggregationQuery", "description": "An aggregation query." @@ -5440,6 +5763,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query." @@ -5772,14 +6099,14 @@ "properties": { "arrayValue": { "$ref": "ArrayValue", - "description": "An array value. Cannot directly contain another array value, though can contain a map which contains another array." + "description": "An array value. In Standard edition databases, an array value cannot directly contain another array value, though it can contain a map which contains another array. In Enterprise edition databases, an array value can contain another array value." }, "booleanValue": { "description": "A boolean value.", "type": "boolean" }, "bytesValue": { - "description": "A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.", + "description": "A bytes value. In Standard edition databases: * The value must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits.", "format": "byte", "type": "string" }, @@ -5828,7 +6155,7 @@ "type": "string" }, "stringValue": { - "description": "A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.", + "description": "A string value. In Standard edition databases: * The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes of the UTF-8 representation are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits.", "type": "string" }, "timestampValue": { @@ -5888,6 +6215,10 @@ "description": "Labels associated with this write request.", "type": "object" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for the request." + }, "streamId": { "description": "The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.", "type": "string" diff --git a/discovery/firestore-v1beta1.json b/discovery/firestore-v1beta1.json index 31649b4205e..3ad11112ca5 100644 --- a/discovery/firestore-v1beta1.json +++ b/discovery/firestore-v1beta1.json @@ -775,6 +775,12 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/.*$", "required": true, "type": "string" + }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" } }, "path": "v1beta1/{+parent}/{collectionId}", @@ -815,6 +821,12 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$", "required": true, "type": "string" + }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" } }, "path": "v1beta1/{+name}", @@ -883,6 +895,12 @@ "location": "query", "type": "string" }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" + }, "transaction": { "description": "Reads the document in a transaction.", "format": "byte", @@ -955,6 +973,12 @@ "location": "query", "type": "boolean" }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" + }, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1061,6 +1085,12 @@ "location": "query", "type": "boolean" }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" + }, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1173,6 +1203,12 @@ "required": true, "type": "string" }, + "requestOptions.requestTags": { + "description": "Optional. The request tags for the request.", + "location": "query", + "repeated": true, + "type": "string" + }, "updateMask.fieldPaths": { "description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.", "location": "query", @@ -1441,7 +1477,7 @@ } } }, - "revision": "20260706", + "revision": "20260810", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1530,6 +1566,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "transaction": { "description": "Reads documents in a transaction.", "format": "byte", @@ -1574,6 +1614,10 @@ "description": "Labels associated with this batch write.", "type": "object" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "writes": { "description": "The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.", "items": { @@ -1612,6 +1656,10 @@ "options": { "$ref": "TransactionOptions", "description": "The options for the transaction. Defaults to a read-write transaction." + }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." } }, "type": "object" @@ -1680,6 +1728,10 @@ "description": "The request for Firestore.Commit.", "id": "CommitRequest", "properties": { + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "transaction": { "description": "If set, applies all writes in this transaction, and commits it.", "format": "byte", @@ -1944,6 +1996,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "structuredPipeline": { "$ref": "StructuredPipeline", "description": "A pipelined operation." @@ -1957,7 +2013,7 @@ "type": "object" }, "ExecutePipelineResponse": { - "description": "The response for Firestore.Execute.", + "description": "The response for Firestore.ExecutePipeline.", "id": "ExecutePipelineResponse", "properties": { "executionTime": { @@ -2492,7 +2548,42 @@ "GoogleFirestoreAdminV1UpdateDatabaseMetadata": { "description": "Metadata related to the update database operation.", "id": "GoogleFirestoreAdminV1UpdateDatabaseMetadata", - "properties": {}, + "properties": { + "endTime": { + "description": "The time this operation completed. Will be unset if operation still in progress.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "The time this operation started.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The state of the operation.", + "enum": [ + "OPERATION_STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "CANCELLING", + "FINALIZING", + "SUCCESSFUL", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified.", + "Request is being prepared for processing.", + "Request is actively being processed.", + "Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.", + "Request has been processed and is in its finalization stage.", + "Request has completed successfully.", + "Request has finished being processed, but encountered an error.", + "Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation." + ], + "type": "string" + } + }, "type": "object" }, "GoogleFirestoreAdminV1beta1ExportDocumentsMetadata": { @@ -2878,6 +2969,10 @@ "description": "Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", "format": "google-datetime", "type": "string" + }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." } }, "type": "object" @@ -2937,6 +3032,10 @@ "description": "The ID of a target to remove from this stream.", "format": "int32", "type": "integer" + }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for the request." } }, "type": "object" @@ -3030,6 +3129,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for the request." + }, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported." @@ -3170,10 +3273,28 @@ }, "type": "object" }, + "RequestOptions": { + "description": "Options for a server request.", + "id": "RequestOptions", + "properties": { + "requestTags": { + "description": "Optional. The request tags for the request.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "RollbackRequest": { "description": "The request for Firestore.Rollback.", "id": "RollbackRequest", "properties": { + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "transaction": { "description": "Required. The transaction to roll back.", "format": "byte", @@ -3199,6 +3320,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for the request." + }, "structuredAggregationQuery": { "$ref": "StructuredAggregationQuery", "description": "An aggregation query." @@ -3253,6 +3378,10 @@ "format": "google-datetime", "type": "string" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for this request." + }, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query." @@ -3585,14 +3714,14 @@ "properties": { "arrayValue": { "$ref": "ArrayValue", - "description": "An array value. Cannot directly contain another array value, though can contain a map which contains another array." + "description": "An array value. In Standard edition databases, an array value cannot directly contain another array value, though it can contain a map which contains another array. In Enterprise edition databases, an array value can contain another array value." }, "booleanValue": { "description": "A boolean value.", "type": "boolean" }, "bytesValue": { - "description": "A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.", + "description": "A bytes value. In Standard edition databases: * The value must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits.", "format": "byte", "type": "string" }, @@ -3641,7 +3770,7 @@ "type": "string" }, "stringValue": { - "description": "A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.", + "description": "A string value. In Standard edition databases: * The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes of the UTF-8 representation are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits.", "type": "string" }, "timestampValue": { @@ -3701,6 +3830,10 @@ "description": "Labels associated with this write request.", "type": "object" }, + "requestOptions": { + "$ref": "RequestOptions", + "description": "Optional. The request options for the request." + }, "streamId": { "description": "The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.", "type": "string" diff --git a/discovery/firestore-v1beta2.json b/discovery/firestore-v1beta2.json index f2c09cb0080..738528dd246 100644 --- a/discovery/firestore-v1beta2.json +++ b/discovery/firestore-v1beta2.json @@ -867,7 +867,7 @@ } } }, - "revision": "20260323", + "revision": "20260810", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Empty": { @@ -1104,7 +1104,42 @@ "GoogleFirestoreAdminV1UpdateDatabaseMetadata": { "description": "Metadata related to the update database operation.", "id": "GoogleFirestoreAdminV1UpdateDatabaseMetadata", - "properties": {}, + "properties": { + "endTime": { + "description": "The time this operation completed. Will be unset if operation still in progress.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "The time this operation started.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The state of the operation.", + "enum": [ + "OPERATION_STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "CANCELLING", + "FINALIZING", + "SUCCESSFUL", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified.", + "Request is being prepared for processing.", + "Request is actively being processed.", + "Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.", + "Request has been processed and is in its finalization stage.", + "Request has completed successfully.", + "Request has finished being processed, but encountered an error.", + "Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation." + ], + "type": "string" + } + }, "type": "object" }, "GoogleFirestoreAdminV1beta2ExportDocumentsMetadata": { diff --git a/discovery/games-v1.json b/discovery/games-v1.json index a89f6fbb446..8e90a8dfc94 100644 --- a/discovery/games-v1.json +++ b/discovery/games-v1.json @@ -615,6 +615,37 @@ } } }, + "gameStats": { + "methods": { + "batchRecordEvents": { + "description": "Records a batch of player game events for a specific player. This method allows sending multiple events in a single request.", + "flatPath": "games/v1/players/{playerId}/gameStats:batchRecordEvents", + "httpMethod": "POST", + "id": "games.gameStats.batchRecordEvents", + "parameterOrder": [ + "playerId" + ], + "parameters": { + "playerId": { + "description": "Required. The player ID of the player that performed the events.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "games/v1/players/{playerId}/gameStats:batchRecordEvents", + "request": { + "$ref": "BatchRecordEventsRequest" + }, + "response": { + "$ref": "BatchRecordEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/games" + ] + } + } + }, "leaderboards": { "methods": { "get": { @@ -752,37 +783,6 @@ } } }, - "playerGameEvents": { - "methods": { - "batchRecordEvents": { - "description": "Records a batch of player game events for a specific player. This method allows sending multiple events in a single request.", - "flatPath": "games/v1/players/{playerId}/gameEvents:batchRecordEvents", - "httpMethod": "POST", - "id": "games.playerGameEvents.batchRecordEvents", - "parameterOrder": [ - "playerId" - ], - "parameters": { - "playerId": { - "description": "Required. The player ID of the player that performed the events.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "games/v1/players/{playerId}/gameEvents:batchRecordEvents", - "request": { - "$ref": "BatchRecordEventsRequest" - }, - "response": { - "$ref": "BatchRecordEventsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/games" - ] - } - } - }, "players": { "methods": { "get": { @@ -1501,7 +1501,7 @@ } } }, - "revision": "20260730", + "revision": "20260813", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index a8d8b691e22..692aafe4f97 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -2596,7 +2596,7 @@ } } }, - "revision": "20260808", + "revision": "20260817", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6209,6 +6209,21 @@ "properties": {}, "type": "object" }, + "PerStageSoakDurationOverrides": { + "description": "Configuration for per-stage soak duration overrides.", + "id": "PerStageSoakDurationOverrides", + "properties": { + "stageOverrides": { + "additionalProperties": { + "format": "google-duration", + "type": "string" + }, + "description": "Required. A mapping of stage numbers to their respective desired soak durations. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage.", + "type": "object" + } + }, + "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", @@ -6834,19 +6849,29 @@ "readOnly": true, "type": "string" }, + "ignoreClusterDisruptionBudgets": { + "description": "Optional. If set to true, the rollout will ignore the disruption budgets of the clusters.", + "type": "boolean" + }, + "ignoreMaintenancePolicies": { + "description": "Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters.", + "type": "boolean" + }, "intent": { "description": "Output only. The intent of the rollout.", "enum": [ "ROLLOUT_INTENT_UNSPECIFIED", "REGULAR_UPGRADE", "CONTROL_PLANE_PATCH_ENFORCEMENT", - "END_OF_SUPPORT_ENFORCEMENT" + "END_OF_SUPPORT_ENFORCEMENT", + "PARTIAL_PATCH" ], "enumDescriptions": [ "The default value.", "A standard rollout for the whole sequence.", "A mandatory upgrade for clusters that haven't been patched within the allowed window.", - "A mandatory upgrade for clusters that have reached its end of support." + "A mandatory upgrade for clusters that have reached its end of support.", + "A patch upgrade for a subset of clusters on a given minor version." ], "readOnly": true, "type": "string" @@ -6874,6 +6899,14 @@ "description": "Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`.", "type": "string" }, + "stageSoakDurationOverrides": { + "additionalProperties": { + "format": "google-duration", + "type": "string" + }, + "description": "Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage.", + "type": "object" + }, "stages": { "description": "Output only. The stages of the Rollout.", "items": { @@ -8097,6 +8130,27 @@ "description": "Optional. If set to true, any rollout already running on the first stage of the sequence will be cancelled to allow for the creation of the new rollout.", "type": "boolean" }, + "ignoreClusterDisruptionBudgets": { + "description": "Optional. If set to true, the rollout will ignore the disruption budgets of the clusters.", + "type": "boolean" + }, + "ignoreMaintenancePolicies": { + "description": "Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters.", + "type": "boolean" + }, + "patchOnly": { + "description": "Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version.", + "type": "boolean" + }, + "soakDurationOverrideAllStages": { + "description": "Optional. Overrides the soak duration for all stages of the rollout.", + "format": "google-duration", + "type": "string" + }, + "soakDurationOverridePerStage": { + "$ref": "PerStageSoakDurationOverrides", + "description": "Optional. Overrides the soak durations for specific stages of the rollout." + }, "upgradeType": { "description": "Required. The type of upgrade.", "enum": [ diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 12cf307c7a9..a5309b918b4 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -2740,7 +2740,7 @@ } } }, - "revision": "20260731", + "revision": "20260817", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6722,6 +6722,21 @@ "properties": {}, "type": "object" }, + "PerStageSoakDurationOverrides": { + "description": "Configuration for per-stage soak duration overrides.", + "id": "PerStageSoakDurationOverrides", + "properties": { + "stageOverrides": { + "additionalProperties": { + "format": "google-duration", + "type": "string" + }, + "description": "Required. A mapping of stage numbers to their respective desired soak durations. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage.", + "type": "object" + } + }, + "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", @@ -7347,19 +7362,29 @@ "readOnly": true, "type": "string" }, + "ignoreClusterDisruptionBudgets": { + "description": "Optional. If set to true, the rollout will ignore the disruption budgets of the clusters.", + "type": "boolean" + }, + "ignoreMaintenancePolicies": { + "description": "Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters.", + "type": "boolean" + }, "intent": { "description": "Output only. The intent of the rollout.", "enum": [ "ROLLOUT_INTENT_UNSPECIFIED", "REGULAR_UPGRADE", "CONTROL_PLANE_PATCH_ENFORCEMENT", - "END_OF_SUPPORT_ENFORCEMENT" + "END_OF_SUPPORT_ENFORCEMENT", + "PARTIAL_PATCH" ], "enumDescriptions": [ "The default value.", "A standard rollout for the whole sequence.", "A mandatory upgrade for clusters that haven't been patched within the allowed window.", - "A mandatory upgrade for clusters that have reached its end of support." + "A mandatory upgrade for clusters that have reached its end of support.", + "A patch upgrade for a subset of clusters on a given minor version." ], "readOnly": true, "type": "string" @@ -7387,6 +7412,14 @@ "description": "Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`.", "type": "string" }, + "stageSoakDurationOverrides": { + "additionalProperties": { + "format": "google-duration", + "type": "string" + }, + "description": "Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage.", + "type": "object" + }, "stages": { "description": "Output only. The stages of the Rollout.", "items": { @@ -8732,6 +8765,27 @@ "description": "Optional. If set to true, any rollout already running on the first stage of the sequence will be cancelled to allow for the creation of the new rollout.", "type": "boolean" }, + "ignoreClusterDisruptionBudgets": { + "description": "Optional. If set to true, the rollout will ignore the disruption budgets of the clusters.", + "type": "boolean" + }, + "ignoreMaintenancePolicies": { + "description": "Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters.", + "type": "boolean" + }, + "patchOnly": { + "description": "Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version.", + "type": "boolean" + }, + "soakDurationOverrideAllStages": { + "description": "Optional. Overrides the soak duration for all stages of the rollout.", + "format": "google-duration", + "type": "string" + }, + "soakDurationOverridePerStage": { + "$ref": "PerStageSoakDurationOverrides", + "description": "Optional. Overrides the soak durations for specific stages of the rollout." + }, "upgradeType": { "description": "Required. The type of upgrade.", "enum": [ diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index 2bfd9e1c9af..a6ef28bf23f 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -2596,7 +2596,7 @@ } } }, - "revision": "20260808", + "revision": "20260817", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6335,6 +6335,21 @@ "properties": {}, "type": "object" }, + "PerStageSoakDurationOverrides": { + "description": "Configuration for per-stage soak duration overrides.", + "id": "PerStageSoakDurationOverrides", + "properties": { + "stageOverrides": { + "additionalProperties": { + "format": "google-duration", + "type": "string" + }, + "description": "Required. A mapping of stage numbers to their respective desired soak durations. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage.", + "type": "object" + } + }, + "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", @@ -6960,19 +6975,29 @@ "readOnly": true, "type": "string" }, + "ignoreClusterDisruptionBudgets": { + "description": "Optional. If set to true, the rollout will ignore the disruption budgets of the clusters.", + "type": "boolean" + }, + "ignoreMaintenancePolicies": { + "description": "Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters.", + "type": "boolean" + }, "intent": { "description": "Output only. The intent of the rollout.", "enum": [ "ROLLOUT_INTENT_UNSPECIFIED", "REGULAR_UPGRADE", "CONTROL_PLANE_PATCH_ENFORCEMENT", - "END_OF_SUPPORT_ENFORCEMENT" + "END_OF_SUPPORT_ENFORCEMENT", + "PARTIAL_PATCH" ], "enumDescriptions": [ "The default value.", "A standard rollout for the whole sequence.", "A mandatory upgrade for clusters that haven't been patched within the allowed window.", - "A mandatory upgrade for clusters that have reached its end of support." + "A mandatory upgrade for clusters that have reached its end of support.", + "A patch upgrade for a subset of clusters on a given minor version." ], "readOnly": true, "type": "string" @@ -7000,6 +7025,14 @@ "description": "Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`.", "type": "string" }, + "stageSoakDurationOverrides": { + "additionalProperties": { + "format": "google-duration", + "type": "string" + }, + "description": "Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage.", + "type": "object" + }, "stages": { "description": "Output only. The stages of the Rollout.", "items": { @@ -8223,6 +8256,27 @@ "description": "Optional. If set to true, any rollout already running on the first stage of the sequence will be cancelled to allow for the creation of the new rollout.", "type": "boolean" }, + "ignoreClusterDisruptionBudgets": { + "description": "Optional. If set to true, the rollout will ignore the disruption budgets of the clusters.", + "type": "boolean" + }, + "ignoreMaintenancePolicies": { + "description": "Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters.", + "type": "boolean" + }, + "patchOnly": { + "description": "Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version.", + "type": "boolean" + }, + "soakDurationOverrideAllStages": { + "description": "Optional. Overrides the soak duration for all stages of the rollout.", + "format": "google-duration", + "type": "string" + }, + "soakDurationOverridePerStage": { + "$ref": "PerStageSoakDurationOverrides", + "description": "Optional. Overrides the soak durations for specific stages of the rollout." + }, "upgradeType": { "description": "Required. The type of upgrade.", "enum": [ diff --git a/discovery/health-v4.json b/discovery/health-v4.json index 4b9755d80e1..11756ad54d0 100644 --- a/discovery/health-v4.json +++ b/discovery/health-v4.json @@ -26,9 +26,6 @@ "https://www.googleapis.com/auth/googlehealth.location.readonly": { "description": "See exercise GPS location data in Google Health" }, - "https://www.googleapis.com/auth/googlehealth.location.writeonly": { - "description": "Add exercise GPS location data to Google Health, and edit or delete the data it adds." - }, "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly": { "description": "Add logged symptoms data to Google Health, and edit or delete the data it adds" }, @@ -712,7 +709,6 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", - "https://www.googleapis.com/auth/googlehealth.location.writeonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", @@ -747,7 +743,6 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", - "https://www.googleapis.com/auth/googlehealth.location.writeonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", @@ -781,9 +776,16 @@ }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", - "https://www.googleapis.com/auth/googlehealth.sleep.readonly" + "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", + "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", + "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", + "https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", + "https://www.googleapis.com/auth/googlehealth.sleep.readonly", + "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" ] }, "exportExerciseTcx": { @@ -886,9 +888,16 @@ }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", - "https://www.googleapis.com/auth/googlehealth.sleep.readonly" + "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", + "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", + "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", + "https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", + "https://www.googleapis.com/auth/googlehealth.sleep.readonly", + "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" ] }, "patch": { @@ -918,7 +927,6 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", - "https://www.googleapis.com/auth/googlehealth.location.writeonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", @@ -974,7 +982,6 @@ "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", - "https://www.googleapis.com/auth/googlehealth.location.writeonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", @@ -1009,9 +1016,16 @@ }, "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", + "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", + "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", - "https://www.googleapis.com/auth/googlehealth.sleep.readonly" + "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", + "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", + "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", + "https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", + "https://www.googleapis.com/auth/googlehealth.sleep.readonly", + "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" ] } } @@ -1086,7 +1100,7 @@ } } }, - "revision": "20260805", + "revision": "20260817", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -6016,7 +6030,43 @@ "CHEST_PAIN", "FATIGUE", "CONFUSION", - "DIZZINESS" + "DIZZINESS", + "ABDOMINAL_PAIN", + "BLADDER_LEAKS", + "BLEEDING_GUMS", + "BRAIN_FOG", + "BURNING_MOUTH", + "CONSTIPATION", + "CRAVINGS", + "DECREASED_APPETITE", + "DIARRHEA", + "DRAWING_PAIN", + "DRY_EYES", + "DRY_HAIR", + "DRY_SKIN", + "EXHAUSTION", + "FEEL_GOOD", + "FOOD_AVERSIONS", + "HAIR_LOSS", + "HEARTBURN", + "HYPERPIGMENTATION", + "INCREASED_APPETITE", + "INCREASED_APPETITE_V2", + "INSOMNIA", + "JOINT_PAIN", + "LEG_CRAMPS", + "MILKY_NIPPLE_DISCHARGE", + "NAUSEA", + "NIGHT_SWEATS", + "NORMAL_DIGESTION", + "NORMAL_STOOL", + "PERINEUM_PAIN", + "SLEEPINESS", + "STRETCH_MARKS", + "SWELLING", + "VAGINAL_DRYNESS", + "VAGINAL_ITCHING", + "VOMITING" ], "enumDescriptions": [ "Unspecified symptom value.", @@ -6048,7 +6098,43 @@ "Chest pain or discomfort.", "Fatigue or extreme tiredness.", "Confusion or mental fogginess.", - "Dizziness or lightheadedness." + "Dizziness or lightheadedness.", + "Abdominal pain.", + "Bladder leaks.", + "Bleeding gums.", + "Brain fog.", + "Burning mouth.", + "Constipation.", + "Food cravings.", + "Decreased appetite.", + "Diarrhea.", + "Drawing pain.", + "Dry eyes.", + "Dry hair.", + "Dry skin.", + "Exhaustion.", + "Feeling good or well.", + "Food aversions.", + "Hair loss.", + "Heartburn.", + "Hyperpigmentation.", + "Increased appetite.", + "Increased appetite V2.", + "Insomnia or difficulty sleeping.", + "Joint pain.", + "Leg cramps.", + "Milky nipple discharge.", + "Nausea.", + "Night sweats.", + "Normal digestion.", + "Normal stool.", + "Perineum pain.", + "Sleepiness or drowsiness.", + "Stretch marks.", + "Swelling.", + "Vaginal dryness.", + "Vaginal itching.", + "Vomiting." ], "type": "string" }, diff --git a/discovery/index.json b/discovery/index.json index 8bde157657f..fc3d0a81f57 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -660,21 +660,6 @@ "title": "Apigee API", "version": "v1" }, - { - "description": "", - "discoveryRestUrl": "https://apigeeregistry.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": "apigeeregistry:v1", - "kind": "discovery#directoryItem", - "name": "apigeeregistry", - "preferred": true, - "title": "Apigee Registry API", - "version": "v1" - }, { "description": "", "discoveryRestUrl": "https://apihub.googleapis.com/$discovery/rest?version=v1", @@ -6337,7 +6322,7 @@ "version": "v1" }, { - "description": "Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", + "description": "The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", "discoveryRestUrl": "https://retail.googleapis.com/$discovery/rest?version=v2alpha", "documentationLink": "https://cloud.google.com/recommendations", "icons": { @@ -6348,11 +6333,11 @@ "kind": "discovery#directoryItem", "name": "retail", "preferred": false, - "title": "Vertex AI Search for commerce API", + "title": "AI Commerce Search API", "version": "v2alpha" }, { - "description": "Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", + "description": "The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", "discoveryRestUrl": "https://retail.googleapis.com/$discovery/rest?version=v2beta", "documentationLink": "https://cloud.google.com/recommendations", "icons": { @@ -6363,11 +6348,11 @@ "kind": "discovery#directoryItem", "name": "retail", "preferred": false, - "title": "Vertex AI Search for commerce API", + "title": "AI Commerce Search API", "version": "v2beta" }, { - "description": "Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", + "description": "The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", "discoveryRestUrl": "https://retail.googleapis.com/$discovery/rest?version=v2", "documentationLink": "https://cloud.google.com/recommendations", "icons": { @@ -6378,7 +6363,7 @@ "kind": "discovery#directoryItem", "name": "retail", "preferred": true, - "title": "Vertex AI Search for commerce API", + "title": "AI Commerce Search API", "version": "v2" }, { diff --git a/discovery/kmsinventory-v1.json b/discovery/kmsinventory-v1.json index 17c8616f947..fd17db5639c 100644 --- a/discovery/kmsinventory-v1.json +++ b/discovery/kmsinventory-v1.json @@ -306,7 +306,7 @@ } } }, - "revision": "20260809", + "revision": "20260816", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { @@ -803,7 +803,7 @@ "type": "string" }, "trustedWrappingEnabled": { - "description": "Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion.", + "description": "Optional. Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion.", "type": "boolean" } }, @@ -1039,12 +1039,14 @@ "enum": [ "ATTESTATION_FORMAT_UNSPECIFIED", "CAVIUM_V1_COMPRESSED", - "CAVIUM_V2_COMPRESSED" + "CAVIUM_V2_COMPRESSED", + "CAVIUM_V209" ], "enumDescriptions": [ "Not specified.", "Cavium HSM attestation compressed with gzip. Note that this format is defined by Cavium and subject to change at any time. See https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html.", - "Cavium HSM attestation V2 compressed with gzip. This is a new format introduced in Cavium's version 3.2-08." + "Cavium HSM attestation V2 compressed with gzip. This is a new format introduced in Cavium's version 3.2-08.", + "Cavium HSM attestation V209, introduced in Cavium's version 2.09-0702." ], "readOnly": true, "type": "string" diff --git a/discovery/merchantapi-notifications_v1.json b/discovery/merchantapi-notifications_v1.json index b4afe4074ab..b70c4ccdec2 100644 --- a/discovery/merchantapi-notifications_v1.json +++ b/discovery/merchantapi-notifications_v1.json @@ -197,13 +197,13 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`.", + "description": "Optional. The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.", + "description": "Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.", "location": "query", "type": "string" }, @@ -262,7 +262,7 @@ } } }, - "revision": "20260722", + "revision": "20260817", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/merchantapi-notifications_v1beta.json b/discovery/merchantapi-notifications_v1beta.json index 357e3946d14..898c9336799 100644 --- a/discovery/merchantapi-notifications_v1beta.json +++ b/discovery/merchantapi-notifications_v1beta.json @@ -197,13 +197,13 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`.", + "description": "Optional. The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.", + "description": "Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.", "location": "query", "type": "string" }, @@ -262,7 +262,7 @@ } } }, - "revision": "20260722", + "revision": "20260817", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index 9895f5ee50f..b4e405432da 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -1797,7 +1797,7 @@ } } }, - "revision": "20260724", + "revision": "20260812", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -5665,6 +5665,10 @@ "$ref": "StorageBucketInfo", "description": "Display information of a Storage Bucket. Used only for return traces." }, + "viewerPermissionMissingInfo": { + "$ref": "ViewerPermissionMissingInfo", + "description": "Display information of a step that is redacted due to missing permissions." + }, "vpcConnector": { "$ref": "VpcConnectorInfo", "description": "Display information of a VPC connector." @@ -5742,6 +5746,32 @@ }, "type": "object" }, + "ViewerPermissionMissingInfo": { + "description": "For display only. Metadata associated with a step that was redacted due to missing permissions.", + "id": "ViewerPermissionMissingInfo", + "properties": { + "resourceTypes": { + "description": "Types of the resources that the user does not have permission to view.", + "items": { + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "FIREWALL", + "INSTANCE", + "FORWARDING_RULE" + ], + "enumDescriptions": [ + "Resource type is unspecified.", + "Firewall rule.", + "Instance.", + "Forwarding rule." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "VpcConnectorInfo": { "description": "For display only. Metadata associated with a VPC connector.", "id": "VpcConnectorInfo", diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index 06f6aa05c06..3f4092babeb 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -1237,7 +1237,7 @@ } } }, - "revision": "20260724", + "revision": "20260812", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -4489,6 +4489,10 @@ "$ref": "StorageBucketInfo", "description": "Display information of a Storage Bucket. Used only for return traces." }, + "viewerPermissionMissingInfo": { + "$ref": "ViewerPermissionMissingInfo", + "description": "Display information of a step that is redacted due to missing permissions." + }, "vpcConnector": { "$ref": "VpcConnectorInfo", "description": "Display information of a VPC connector." @@ -4566,6 +4570,32 @@ }, "type": "object" }, + "ViewerPermissionMissingInfo": { + "description": "For display only. Metadata associated with a step that was redacted due to missing permissions.", + "id": "ViewerPermissionMissingInfo", + "properties": { + "resourceTypes": { + "description": "Types of the resources that the user does not have permission to view.", + "items": { + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "FIREWALL", + "INSTANCE", + "FORWARDING_RULE" + ], + "enumDescriptions": [ + "Resource type is unspecified.", + "Firewall rule.", + "Instance.", + "Forwarding rule." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "VpcConnectorInfo": { "description": "For display only. Metadata associated with a VPC connector.", "id": "VpcConnectorInfo", diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 9603583c42d..c51c9a4e7f8 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -4189,7 +4189,7 @@ } } }, - "revision": "20260807", + "revision": "20260816", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AgentConnectivityTemplate": { @@ -5026,7 +5026,7 @@ "type": "array" }, "resources": { - "description": "Optional. A list of non-empty strings whose value is matched against the resource value. If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources.", + "description": "Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources.", "items": { "$ref": "ExtensionBindingMatchConditionStringMatch" }, @@ -5054,7 +5054,7 @@ "id": "ExtensionBindingTarget", "properties": { "resources": { - "description": "Optional. The reference to the target resource, to which this binding should attach. Exactly one of `resources` or `scope` must be set. For Agent Gateway, this would be the full resource name, in the format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`. For AI App, this would be the full resource name, in the format: `projects/{project}/locations/{location}/applications/{application}`.", + "description": "Optional. The reference to the target resource, to which this binding should attach. Exactly one of `resources` or `scope` must be set.", "items": { "type": "string" }, @@ -7578,7 +7578,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements]((https://cloud.google.com/compute/docs/labeling-resources#requirements).", + "description": "Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements).", "type": "object" }, "name": { diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 7e86960c35d..550dcc27c98 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -3734,7 +3734,7 @@ } } }, - "revision": "20260807", + "revision": "20260816", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AgentConnectivityTemplate": { @@ -4439,7 +4439,7 @@ "type": "array" }, "resources": { - "description": "Optional. A list of non-empty strings whose value is matched against the resource value. If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources.", + "description": "Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources.", "items": { "$ref": "ExtensionBindingMatchConditionStringMatch" }, @@ -4467,7 +4467,7 @@ "id": "ExtensionBindingTarget", "properties": { "resources": { - "description": "Optional. The reference to the target resource, to which this binding should attach. Exactly one of `resources` or `scope` must be set. For Agent Gateway, this would be the full resource name, in the format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`. For AI App, this would be the full resource name, in the format: `projects/{project}/locations/{location}/applications/{application}`.", + "description": "Optional. The reference to the target resource, to which this binding should attach. Exactly one of `resources` or `scope` must be set.", "items": { "type": "string" }, @@ -6850,7 +6850,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements]((https://cloud.google.com/compute/docs/labeling-resources#requirements).", + "description": "Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements).", "type": "object" }, "name": { diff --git a/discovery/notebooks-v1.json b/discovery/notebooks-v1.json index 4224340cb80..9ca7cc231e5 100644 --- a/discovery/notebooks-v1.json +++ b/discovery/notebooks-v1.json @@ -4,6 +4,9 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + }, + "https://www.googleapis.com/auth/notebooks": { + "description": "See, edit, configure, and delete your Google Cloud Agent Platform Workbench Instances data and see the email address for your Google Account" } } } @@ -131,7 +134,8 @@ "$ref": "Location" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -178,7 +182,8 @@ "$ref": "ListLocationsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } }, @@ -215,7 +220,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "delete": { @@ -240,7 +246,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "get": { @@ -265,7 +272,8 @@ "$ref": "Environment" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -301,7 +309,8 @@ "$ref": "ListEnvironmentsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } } @@ -338,7 +347,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "delete": { @@ -363,7 +373,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "get": { @@ -388,7 +399,8 @@ "$ref": "Execution" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -434,7 +446,8 @@ "$ref": "ListExecutionsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } } @@ -471,7 +484,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "delete": { @@ -496,7 +510,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "diagnose": { @@ -524,7 +539,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "get": { @@ -549,7 +565,8 @@ "$ref": "Instance" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "getIamPolicy": { @@ -580,7 +597,8 @@ "$ref": "Policy" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "getInstanceHealth": { @@ -605,7 +623,8 @@ "$ref": "GetInstanceHealthResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "isUpgradeable": { @@ -649,7 +668,8 @@ "$ref": "IsInstanceUpgradeableResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -695,7 +715,8 @@ "$ref": "ListInstancesResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "migrate": { @@ -723,7 +744,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "register": { @@ -751,7 +773,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "report": { @@ -779,7 +802,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "reportEvent": { @@ -807,7 +831,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "reset": { @@ -835,7 +860,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "rollback": { @@ -863,7 +889,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "setAccelerator": { @@ -891,7 +918,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "setIamPolicy": { @@ -919,7 +947,8 @@ "$ref": "Policy" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "setLabels": { @@ -947,7 +976,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "setMachineType": { @@ -975,7 +1005,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "start": { @@ -1003,7 +1034,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "stop": { @@ -1031,7 +1063,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "testIamPermissions": { @@ -1059,7 +1092,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "updateConfig": { @@ -1087,7 +1121,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "updateMetadataItems": { @@ -1115,7 +1150,8 @@ "$ref": "UpdateInstanceMetadataItemsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "updateShieldedInstanceConfig": { @@ -1143,7 +1179,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "upgrade": { @@ -1171,7 +1208,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "upgradeInternal": { @@ -1199,7 +1237,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } } @@ -1231,7 +1270,8 @@ "$ref": "Empty" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "delete": { @@ -1256,7 +1296,8 @@ "$ref": "Empty" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "get": { @@ -1281,7 +1322,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -1327,7 +1369,8 @@ "$ref": "ListOperationsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } } @@ -1369,7 +1412,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "delete": { @@ -1399,7 +1443,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "diagnose": { @@ -1427,7 +1472,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "get": { @@ -1452,7 +1498,8 @@ "$ref": "Runtime" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "getIamPolicy": { @@ -1483,7 +1530,8 @@ "$ref": "Policy" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -1529,7 +1577,8 @@ "$ref": "ListRuntimesResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "migrate": { @@ -1557,7 +1606,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "patch": { @@ -1596,7 +1646,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "refreshRuntimeTokenInternal": { @@ -1624,7 +1675,8 @@ "$ref": "RefreshRuntimeTokenInternalResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "reportEvent": { @@ -1652,7 +1704,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "reset": { @@ -1680,7 +1733,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "setIamPolicy": { @@ -1708,7 +1762,8 @@ "$ref": "Policy" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "start": { @@ -1736,7 +1791,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "stop": { @@ -1764,7 +1820,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "switch": { @@ -1792,7 +1849,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "testIamPermissions": { @@ -1820,7 +1878,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "upgrade": { @@ -1848,7 +1907,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } } @@ -1885,7 +1945,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "delete": { @@ -1910,7 +1971,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "get": { @@ -1935,7 +1997,8 @@ "$ref": "Schedule" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -1981,7 +2044,8 @@ "$ref": "ListSchedulesResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "trigger": { @@ -2009,7 +2073,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } } @@ -2019,7 +2084,7 @@ } } }, - "revision": "20260521", + "revision": "20260812", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index 6bd75cc13a9..7def33686df 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -4,6 +4,9 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + }, + "https://www.googleapis.com/auth/notebooks": { + "description": "See, edit, configure, and delete your Google Cloud Agent Platform Workbench Instances data and see the email address for your Google Account" } } } @@ -131,7 +134,8 @@ "$ref": "Location" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -178,7 +182,8 @@ "$ref": "ListLocationsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } }, @@ -210,7 +215,8 @@ "$ref": "CheckAuthorizationResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "checkUpgradability": { @@ -235,7 +241,8 @@ "$ref": "CheckInstanceUpgradabilityResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "create": { @@ -273,7 +280,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "delete": { @@ -303,7 +311,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "diagnose": { @@ -331,7 +340,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "generateAccessToken": { @@ -359,7 +369,8 @@ "$ref": "GenerateAccessTokenResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "get": { @@ -384,7 +395,8 @@ "$ref": "Instance" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "getConfig": { @@ -409,7 +421,8 @@ "$ref": "Config" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "getIamPolicy": { @@ -440,7 +453,8 @@ "$ref": "Policy" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -486,7 +500,8 @@ "$ref": "ListInstancesResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "patch": { @@ -525,7 +540,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "reportInfoSystem": { @@ -553,7 +569,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "reset": { @@ -581,7 +598,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "resizeDisk": { @@ -609,7 +627,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "restore": { @@ -637,7 +656,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "rollback": { @@ -665,7 +685,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "setIamPolicy": { @@ -693,7 +714,8 @@ "$ref": "Policy" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "start": { @@ -721,7 +743,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "stop": { @@ -749,7 +772,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "testIamPermissions": { @@ -777,7 +801,8 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "upgrade": { @@ -805,7 +830,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "upgradeSystem": { @@ -833,7 +859,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } } @@ -865,7 +892,8 @@ "$ref": "Empty" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "delete": { @@ -890,7 +918,8 @@ "$ref": "Empty" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "get": { @@ -915,7 +944,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] }, "list": { @@ -961,7 +991,8 @@ "$ref": "ListOperationsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/notebooks" ] } } @@ -971,7 +1002,7 @@ } } }, - "revision": "20260722", + "revision": "20260812", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2348,6 +2379,11 @@ "description": "Optional. Use this VM image family to find the image; the newest image in this family will be used.", "type": "string" }, + "imageDescription": { + "description": "Output only. A human-readable description of the image running on the instance (for example, \"Debian 11, Python 3.10\"), derived at read time from the image release configuration (the source of truth). Set to \"Custom\" for unrecognized boot-disk images.", + "readOnly": true, + "type": "string" + }, "name": { "description": "Optional. Use VM image name to find the image.", "type": "string" diff --git a/discovery/observability-v1.json b/discovery/observability-v1.json index 634c9dee0fa..4de257794e9 100644 --- a/discovery/observability-v1.json +++ b/discovery/observability-v1.json @@ -1009,6 +1009,39 @@ "resources": { "buckets": { "methods": { + "create": { + "description": "Create a new bucket.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets", + "httpMethod": "POST", + "id": "observability.projects.locations.buckets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "bucketId": { + "description": "Required. Id of the bucket to create.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the project and location for the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/buckets", + "request": { + "$ref": "Bucket" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Get bucket resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}", @@ -1074,6 +1107,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Update a bucket.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/buckets/{bucketsId}", + "httpMethod": "PATCH", + "id": "observability.projects.locations.buckets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", + "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": "Bucket" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1726,7 +1793,7 @@ } } }, - "revision": "20260630", + "revision": "20260817", "rootUrl": "https://observability.googleapis.com/", "schemas": { "Bucket": { diff --git a/discovery/paymentsresellersubscription-v1.json b/discovery/paymentsresellersubscription-v1.json index 51dacf287ab..272f1e04f5e 100644 --- a/discovery/paymentsresellersubscription-v1.json +++ b/discovery/paymentsresellersubscription-v1.json @@ -586,7 +586,7 @@ } } }, - "revision": "20260607", + "revision": "20260816", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "Amount": { @@ -1718,6 +1718,12 @@ "description": "Describes the details of the migrated subscription.", "id": "SubscriptionMigrationDetails", "properties": { + "legacyCreationTime": { + "description": "Output only. The creation time of the migrated subscription in the legacy system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "migratedSubscriptionId": { "description": "Output only. The migrated subscription id in the legacy system.", "readOnly": true, diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index f3763d8dba4..5726ebf5e03 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -12,7 +12,7 @@ "baseUrl": "https://retail.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Retail", - "description": "Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", + "description": "The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/recommendations", "fullyEncodeReservedExpansion": true, @@ -2353,7 +2353,7 @@ } } }, - "revision": "20260723", + "revision": "20260813", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -8434,7 +8434,7 @@ } }, "servicePath": "", - "title": "Vertex AI Search for commerce API", + "title": "AI Commerce Search API", "version": "v2", "version_module": true } \ No newline at end of file diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index c415f280316..399f5515bb4 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -12,7 +12,7 @@ "baseUrl": "https://retail.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Retail", - "description": "Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", + "description": "The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/recommendations", "fullyEncodeReservedExpansion": true, @@ -2874,7 +2874,7 @@ } } }, - "revision": "20260803", + "revision": "20260813", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -9549,7 +9549,7 @@ } }, "servicePath": "", - "title": "Vertex AI Search for commerce API", + "title": "AI Commerce Search API", "version": "v2alpha", "version_module": true } \ No newline at end of file diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 94ccc442426..e6da23497cd 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -12,7 +12,7 @@ "baseUrl": "https://retail.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Retail", - "description": "Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", + "description": "The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/recommendations", "fullyEncodeReservedExpansion": true, @@ -2498,7 +2498,7 @@ } } }, - "revision": "20260723", + "revision": "20260813", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -8799,7 +8799,7 @@ } }, "servicePath": "", - "title": "Vertex AI Search for commerce API", + "title": "AI Commerce Search API", "version": "v2beta", "version_module": true } \ No newline at end of file diff --git a/discovery/run-v1.json b/discovery/run-v1.json index a54d121e53b..f309e2f7081 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -3652,7 +3652,7 @@ } } }, - "revision": "20260807", + "revision": "20260814", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4317,6 +4317,10 @@ "description": "ExecutionSpec describes how the execution will look.", "id": "ExecutionSpec", "properties": { + "delayExecution": { + "description": "Optional. If true, the system will start the execution within the next 12 hours depending on available capacity.", + "type": "boolean" + }, "parallelism": { "description": "Optional. Specifies the maximum desired number of tasks the execution should run at given time. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed, i.e. when the work left to do is less than max parallelism.", "format": "int32", @@ -5417,6 +5421,10 @@ "description": "Required. Where should the files be placed on the worker.", "type": "string" }, + "fetchTags": { + "description": "Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags.", + "type": "boolean" + }, "recurseSubmodules": { "description": "Optional. True if submodules should be fetched too (default false).", "type": "boolean" @@ -6968,7 +6976,7 @@ "additionalProperties": { "type": "string" }, - "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance.", + "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance.", "type": "object" }, "clusterName": { @@ -7054,6 +7062,10 @@ }, "type": "array" }, + "delayExecution": { + "description": "Optional. If true, the system will start the execution within the next 12 hours depending on available capacity.", + "type": "boolean" + }, "taskCount": { "description": "The desired number of tasks the execution should run. Will replace existing task_count value.", "format": "int32", diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 6318f1dd874..38feb3af0c0 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -2673,7 +2673,7 @@ } } }, - "revision": "20260807", + "revision": "20260814", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2860,7 +2860,8 @@ "CANCELLED", "CANCELLING", "DELETED", - "DELAYED_START_PENDING" + "DELAYED_START_PENDING", + "DELAYED_EXECUTION_EXCEEDING_DURATION_LIMIT" ], "enumDescriptions": [ "Default value.", @@ -2869,7 +2870,8 @@ "The execution was cancelled by users.", "The execution is in the process of being cancelled.", "The execution was deleted.", - "A delayed execution is waiting for a start time." + "A delayed execution is waiting for a start time.", + "A delayed execution exceeded the maximum runtime duration." ], "readOnly": true, "type": "string" @@ -3499,6 +3501,10 @@ "description": "Optional. Arbitrary version identifier for the API client.", "type": "string" }, + "delayExecution": { + "description": "Optional. If true, the system will start the execution within the next 12 hours depending on available capacity.", + "type": "boolean" + }, "labels": { "additionalProperties": { "type": "string" @@ -4410,6 +4416,10 @@ }, "type": "array" }, + "delayExecution": { + "description": "Optional. If true, the system will start the execution within the next 12 hours depending on available capacity.", + "type": "boolean" + }, "taskCount": { "description": "Optional. The desired number of tasks the execution should run. Will replace existing task_count value.", "format": "int32", @@ -5009,6 +5019,10 @@ "description": "User-provided description of the Service. This field currently has a 512-character limit.", "type": "string" }, + "durableExecution": { + "description": "Optional. Immutable. Indicates whether the Service has durable execution enabled. This field is immutable once the Service is created.", + "type": "boolean" + }, "etag": { "description": "Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "type": "string" @@ -7132,6 +7146,10 @@ "description": "Required. Where should the files be placed on the worker.", "type": "string" }, + "fetchTags": { + "description": "Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags.", + "type": "boolean" + }, "recurseSubmodules": { "description": "Optional. True if submodules should be fetched too (default false).", "type": "boolean" diff --git a/discovery/saasservicemgmt-v1.json b/discovery/saasservicemgmt-v1.json index 985b605e3da..36b1a9a4934 100644 --- a/discovery/saasservicemgmt-v1.json +++ b/discovery/saasservicemgmt-v1.json @@ -1866,7 +1866,7 @@ } } }, - "revision": "20260708", + "revision": "20260816", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -2721,13 +2721,22 @@ "state": { "description": "Output only. State of the Saas. It is always in STATE_ACTIVE state if the application_template is empty.", "enum": [ + "STATE_UNSPECIFIED", "STATE_TYPE_UNSPECIFIED", "STATE_ACTIVE", "STATE_RUNNING", "STATE_FAILED" ], + "enumDeprecated": [ + false, + true, + false, + false, + false + ], "enumDescriptions": [ - "State type is unspecified.", + "State is unspecified.", + "State type is unspecified. Deprecated: Use STATE_UNSPECIFIED instead.", "The Saas is ready", "In the process of importing, synchronizing or replicating ApplicationTemplates", "Failure during process of importing, synchronizing or replicating ApplicationTemplate processing" @@ -3406,7 +3415,7 @@ "UNIT_OPERATION_STATE_CANCELLED" ], "enumDescriptions": [ - "", + "Unit operation state is unknown.", "Unit operation is accepted but not ready to run.", "Unit operation is accepted and scheduled.", "Unit operation is running.", diff --git a/discovery/saasservicemgmt-v1beta1.json b/discovery/saasservicemgmt-v1beta1.json index ae11f90372d..36817c3d45a 100644 --- a/discovery/saasservicemgmt-v1beta1.json +++ b/discovery/saasservicemgmt-v1beta1.json @@ -3323,7 +3323,7 @@ } } }, - "revision": "20260708", + "revision": "20260816", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -3389,12 +3389,12 @@ "id": "AppParams", "properties": { "group": { - "description": "Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name", + "description": "Optional. Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name", "type": "string" }, "scope": { "$ref": "Scope", - "description": "Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL." + "description": "Optional. Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL." } }, "type": "object" @@ -3433,7 +3433,7 @@ "description": "Reference to the Composite ApplicationTemplate." }, "revision": { - "description": "Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate.", + "description": "Optional. Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate.", "type": "string" } }, @@ -3448,7 +3448,7 @@ "type": "string" }, "revision": { - "description": "Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored.", + "description": "Optional. Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored.", "type": "string" }, "syncOperation": { @@ -3800,6 +3800,20 @@ }, "type": "object" }, + "FlagNameList": { + "description": "Wrapper for a list of flags.", + "id": "FlagNameList", + "properties": { + "flags": { + "description": "Required. Flags to be rolled out.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "FlagRelease": { "description": "A collection of FlagRevisions.", "id": "FlagRelease", @@ -3839,6 +3853,10 @@ "readOnly": true, "type": "string" }, + "flagNamesRelease": { + "$ref": "FlagNameList", + "description": "Optional. Immutable. Specifies the release consisting of a list of flags." + }, "flagRevisions": { "deprecated": true, "description": "Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions.", @@ -4976,13 +4994,22 @@ "state": { "description": "Output only. State of the Saas. It is always in STATE_ACTIVE state if the application_template is empty.", "enum": [ + "STATE_UNSPECIFIED", "STATE_TYPE_UNSPECIFIED", "STATE_ACTIVE", "STATE_RUNNING", "STATE_FAILED" ], + "enumDeprecated": [ + false, + true, + false, + false, + false + ], "enumDescriptions": [ - "State type is unspecified.", + "State is unspecified.", + "State type is unspecified. Deprecated: Use STATE_UNSPECIFIED instead.", "The Saas is ready", "In the process of importing, synchronizing or replicating ApplicationTemplates", "Failure during process of importing, synchronizing or replicating ApplicationTemplate processing" @@ -5639,7 +5666,7 @@ }, "appParams": { "$ref": "AppParams", - "description": "AppParams contains the parameters for creating an AppHub Application." + "description": "Optional. AppParams contains the parameters for creating an AppHub Application." }, "applicationTemplateComponent": { "$ref": "ComponentRef", @@ -5845,7 +5872,7 @@ "UNIT_OPERATION_STATE_CANCELLED" ], "enumDescriptions": [ - "", + "Unit operation state is unknown.", "Unit operation is accepted but not ready to run.", "Unit operation is accepted and scheduled.", "Unit operation is running.", diff --git a/discovery/searchads360-v23.json b/discovery/searchads360-v23.json index 6083c796ae2..45ef7114e75 100644 --- a/discovery/searchads360-v23.json +++ b/discovery/searchads360-v23.json @@ -4969,7 +4969,7 @@ } } }, - "revision": "20260810", + "revision": "20260820", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__Value": { @@ -35384,12 +35384,16 @@ "enum": [ "UNSPECIFIED", "UNKNOWN", - "CUSTOMER_RETENTION" + "CUSTOMER_RETENTION", + "NEW_CUSTOMER_ACQUISITION", + "LOYALTY_RETENTION" ], "enumDescriptions": [ "Not specified.", "Used for return value only. Represents value unknown in this version.", - "Retention goal, which allows advertisers to optimize campaigns to win back lapsed customers. (https://support.google.com/google-ads/answer/14792043?hl=en)" + "Retention goal, which allows advertisers to optimize campaigns to win back lapsed customers. See https://support.google.com/google-ads/answer/14792043 to learn more.", + "New customer acquisition goal, which allows advertisers to optimize campaigns to acquire new customers.", + "Loyalty retention goal, which allows advertisers to optimize campaigns for retaining loyalty program members." ], "readOnly": true, "type": "string" @@ -39854,12 +39858,16 @@ "enum": [ "UNSPECIFIED", "UNKNOWN", - "CUSTOMER_RETENTION" + "CUSTOMER_RETENTION", + "NEW_CUSTOMER_ACQUISITION", + "LOYALTY_RETENTION" ], "enumDescriptions": [ "Not specified.", "Used for return value only. Represents value unknown in this version.", - "Retention goal, which allows advertisers to optimize campaigns to win back lapsed customers. (https://support.google.com/google-ads/answer/14792043?hl=en)" + "Retention goal, which allows advertisers to optimize campaigns to win back lapsed customers. See https://support.google.com/google-ads/answer/14792043 to learn more.", + "New customer acquisition goal, which allows advertisers to optimize campaigns to acquire new customers.", + "Loyalty retention goal, which allows advertisers to optimize campaigns for retaining loyalty program members." ], "readOnly": true, "type": "string" @@ -56800,6 +56808,10 @@ "$ref": "GoogleAdsSearchads360V23Services__CampaignDraftOperation", "description": "A campaign draft mutate operation." }, + "campaignGoalConfigOperation": { + "$ref": "GoogleAdsSearchads360V23Services__CampaignGoalConfigOperation", + "description": "A campaign goal config mutate operation." + }, "campaignGroupOperation": { "$ref": "GoogleAdsSearchads360V23Services__CampaignGroupOperation", "description": "A campaign group mutate operation." @@ -57059,6 +57071,10 @@ "$ref": "GoogleAdsSearchads360V23Services__MutateCampaignDraftResult", "description": "The result for the campaign draft mutate." }, + "campaignGoalConfigResult": { + "$ref": "GoogleAdsSearchads360V23Services__MutateCampaignGoalConfigResult", + "description": "The result for the campaign goal config mutate." + }, "campaignGroupResult": { "$ref": "GoogleAdsSearchads360V23Services__MutateCampaignGroupResult", "description": "The result for the campaign group mutate." diff --git a/discovery/servicecontrol-v1.json b/discovery/servicecontrol-v1.json index 80357ccf671..28ff4759f4b 100644 --- a/discovery/servicecontrol-v1.json +++ b/discovery/servicecontrol-v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20260512", + "revision": "20260806", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -396,6 +396,23 @@ }, "type": "object" }, + "AuditPamBindingId": { + "description": "A composite unique identifier for a PAM Grant which is {Org/Folder/Project identifier, grant Unique Identifier} tuple.", + "id": "AuditPamBindingId", + "properties": { + "container": { + "description": "Output only. GCP Project/Folder/Organization identifier to which the PAM entitlement/grant is bound to. Container will be in the following form: projects/$project_num or folders/$folder_num or organizations/$org", + "readOnly": true, + "type": "string" + }, + "grantUuid": { + "description": "Output only. Represents the unique identifier for the PAM grant. Full_resource_name_pattern for PAM Grant is: //privilegedaccessmanager.googleapis.com/ (projects|folders|organizations)/$0/locations/$1/entitlements/$2/ grants/$3 where $3 is the grant_uuid.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Auth": { "description": "This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.", "id": "Auth", @@ -525,6 +542,11 @@ ], "type": "string" }, + "privilegedAccessManagerMetadata": { + "$ref": "PrivilegedAccessManagerMetadata", + "description": "Output only. Metadata about the Privileged Access Manager (PAM) backed authorization decisions. This field is populated if the access is granted via an IAM policy with a binding which is managed by Privileged Access Manager.", + "readOnly": true + }, "resource": { "description": "The resource being accessed, as a REST-style or cloud resource string. For example: bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID or projects/PROJECTID/datasets/DATASETID", "type": "string" @@ -1399,6 +1421,25 @@ "orgPolicyViolationInfo": { "$ref": "OrgPolicyViolationInfo", "description": "Indicates the orgpolicy violations for this resource." + }, + "rabPolicyViolationInfo": { + "$ref": "RabPolicyViolationInfo", + "description": "Indicates the regional access boundary policy violations for this resource." + } + }, + "type": "object" + }, + "PrivilegedAccessManagerMetadata": { + "description": "Metadata about the Privileged Access Manager (PAM) backed authorization decisions.", + "id": "PrivilegedAccessManagerMetadata", + "properties": { + "pamBindingIds": { + "description": "Output only. If PAM is managing the elevated access, AuditPamBindingId is written to an Identity and Access Management (IAM) policy, which specifies access controls for resources. If the access is granted via an IAM policy with a binding which is managed by Privileged Access Manager, PrivilegedAccessManagerMetadata will contain the AuditPamBindingId.", + "items": { + "$ref": "AuditPamBindingId" + }, + "readOnly": true, + "type": "array" } }, "type": "object" @@ -1575,6 +1616,24 @@ }, "type": "object" }, + "RabPolicyViolationInfo": { + "description": "Represents Regional Access Boundary (RAB) Policy Violation information.", + "id": "RabPolicyViolationInfo", + "properties": { + "errorMessage": { + "description": "Optional. Error message detailing what triggered the violation. The error message content originates from the authz library e.g., google3/cloud/security/iam/cap/deny_explanation/internal/make_error_msg.cc. This will be the same (canonical) error message provided by the http error code.", + "type": "string" + }, + "resourceLocations": { + "description": "Optional. The list of target locations of the resource.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ReportError": { "description": "Represents the processing error of one Operation in the request.", "id": "ReportError", diff --git a/discovery/servicecontrol-v2.json b/discovery/servicecontrol-v2.json index 21e5d3d1d78..51d19915f75 100644 --- a/discovery/servicecontrol-v2.json +++ b/discovery/servicecontrol-v2.json @@ -169,7 +169,7 @@ } } }, - "revision": "20260512", + "revision": "20260806", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { @@ -337,6 +337,23 @@ }, "type": "object" }, + "AuditPamBindingId": { + "description": "A composite unique identifier for a PAM Grant which is {Org/Folder/Project identifier, grant Unique Identifier} tuple.", + "id": "AuditPamBindingId", + "properties": { + "container": { + "description": "Output only. GCP Project/Folder/Organization identifier to which the PAM entitlement/grant is bound to. Container will be in the following form: projects/$project_num or folders/$folder_num or organizations/$org", + "readOnly": true, + "type": "string" + }, + "grantUuid": { + "description": "Output only. Represents the unique identifier for the PAM grant. Full_resource_name_pattern for PAM Grant is: //privilegedaccessmanager.googleapis.com/ (projects|folders|organizations)/$0/locations/$1/entitlements/$2/ grants/$3 where $3 is the grant_uuid.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Auth": { "description": "This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.", "id": "Auth", @@ -466,6 +483,11 @@ ], "type": "string" }, + "privilegedAccessManagerMetadata": { + "$ref": "PrivilegedAccessManagerMetadata", + "description": "Output only. Metadata about the Privileged Access Manager (PAM) backed authorization decisions. This field is populated if the access is granted via an IAM policy with a binding which is managed by Privileged Access Manager.", + "readOnly": true + }, "resource": { "description": "The resource being accessed, as a REST-style or cloud resource string. For example: bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID or projects/PROJECTID/datasets/DATASETID", "type": "string" @@ -643,6 +665,43 @@ "orgPolicyViolationInfo": { "$ref": "OrgPolicyViolationInfo", "description": "Indicates the orgpolicy violations for this resource." + }, + "rabPolicyViolationInfo": { + "$ref": "RabPolicyViolationInfo", + "description": "Indicates the regional access boundary policy violations for this resource." + } + }, + "type": "object" + }, + "PrivilegedAccessManagerMetadata": { + "description": "Metadata about the Privileged Access Manager (PAM) backed authorization decisions.", + "id": "PrivilegedAccessManagerMetadata", + "properties": { + "pamBindingIds": { + "description": "Output only. If PAM is managing the elevated access, AuditPamBindingId is written to an Identity and Access Management (IAM) policy, which specifies access controls for resources. If the access is granted via an IAM policy with a binding which is managed by Privileged Access Manager, PrivilegedAccessManagerMetadata will contain the AuditPamBindingId.", + "items": { + "$ref": "AuditPamBindingId" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "RabPolicyViolationInfo": { + "description": "Represents Regional Access Boundary (RAB) Policy Violation information.", + "id": "RabPolicyViolationInfo", + "properties": { + "errorMessage": { + "description": "Optional. Error message detailing what triggered the violation. The error message content originates from the authz library e.g., google3/cloud/security/iam/cap/deny_explanation/internal/make_error_msg.cc. This will be the same (canonical) error message provided by the http error code.", + "type": "string" + }, + "resourceLocations": { + "description": "Optional. The list of target locations of the resource.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index 7dcf44a8287..f56b8cdd87c 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -431,7 +431,7 @@ } } }, - "revision": "20260721", + "revision": "20260818", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -3735,7 +3735,7 @@ }, "removedValues": { "deprecated": true, - "description": "The values removed from the parent consumer policy.", + "description": "Deprecated: This field is no longer populated. Use GetConsumerPolicy to verify the remaining enabled values.", "items": { "type": "string" }, diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index 2e093f8ae7e..f788ec584e7 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -969,7 +969,7 @@ } } }, - "revision": "20260731", + "revision": "20260818", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -4537,7 +4537,7 @@ }, "removedValues": { "deprecated": true, - "description": "The values removed from the parent consumer policy.", + "description": "Deprecated: This field is no longer populated. Use GetConsumerPolicy to verify the remaining enabled values.", "items": { "type": "string" }, diff --git a/discovery/threatintelligence-v1beta.json b/discovery/threatintelligence-v1beta.json index 600b2e4ad56..701afa6b5cb 100644 --- a/discovery/threatintelligence-v1beta.json +++ b/discovery/threatintelligence-v1beta.json @@ -842,7 +842,7 @@ } } }, - "revision": "20260809", + "revision": "20260816", "rootUrl": "https://threatintelligence.googleapis.com/", "schemas": { "Alert": { @@ -1255,9 +1255,18 @@ "description": "CustomThreatScenarioConfig represents a user-defined threat scenario configuration.", "id": "CustomThreatScenarioConfig", "properties": { + "compiledLuceneQuery": { + "description": "Output only. The compiled Lucene query string.", + "readOnly": true, + "type": "string" + }, "documentCondition": { "description": "Required. The condition driving the scenario, stored as a stringified JSON. This is used to query/filter documents.", "type": "string" + }, + "legacyMonitorMetadata": { + "$ref": "LegacyMetadata", + "description": "Optional. Legacy metadata associated with this scenario/monitor." } }, "type": "object" @@ -1986,6 +1995,81 @@ }, "type": "object" }, + "LegacyMetadata": { + "description": "Legacy metadata associated with this scenario/monitor.", + "id": "LegacyMetadata", + "properties": { + "aggregationEnabled": { + "description": "Optional. Whether aggregation is enabled for alerts from this monitor.", + "type": "boolean" + }, + "aggregationSimilarity": { + "description": "Optional. Similarity threshold for aggregation.", + "format": "double", + "type": "number" + }, + "conditionVersion": { + "description": "Optional. Version of the condition schema.", + "format": "int32", + "type": "integer" + }, + "creatorUserId": { + "description": "Optional. User ID who created the monitor.", + "type": "string" + }, + "description": { + "description": "Optional. Description of the legacy monitor.", + "type": "string" + }, + "disabledCode": { + "description": "Optional. Code indicating why the monitor is disabled (if applicable).", + "type": "string" + }, + "disabledReason": { + "description": "Optional. Reason why the monitor is disabled (if applicable).", + "type": "string" + }, + "displayName": { + "description": "Optional. Name of the legacy monitor.", + "type": "string" + }, + "emailNotificationEnabled": { + "description": "Optional. Whether email notifications are enabled.", + "type": "boolean" + }, + "emailNotificationImmediate": { + "description": "Optional. Whether email notifications are intermediate/immediate.", + "type": "boolean" + }, + "legacyMonitorId": { + "description": "Optional. Unique identifier of the legacy monitor.", + "type": "string" + }, + "staleTime": { + "description": "Optional. Time the legacy monitor was considered stale.", + "format": "google-datetime", + "type": "string" + }, + "templateId": { + "description": "Optional. ID of the template this monitor was created from.", + "type": "string" + }, + "tenantId": { + "description": "Optional. ID of the tenant owning the monitor.", + "type": "string" + }, + "updaterUserId": { + "description": "Optional. User ID who last updated the monitor.", + "type": "string" + }, + "version": { + "description": "Optional. Version of the monitor configuration.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "ListAlertsResponse": { "description": "Response message for ListAlerts.", "id": "ListAlertsResponse", diff --git a/discovery/translate-v3.json b/discovery/translate-v3.json index 340a87344aa..dc65a3eabe2 100644 --- a/discovery/translate-v3.json +++ b/discovery/translate-v3.json @@ -416,7 +416,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v3/projects/{projectsId}/locations", "httpMethod": "GET", "id": "translate.projects.locations.list", @@ -425,7 +425,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1750,7 +1750,7 @@ } } }, - "revision": "20260128", + "revision": "20260814", "rootUrl": "https://translation.googleapis.com/", "schemas": { "AdaptiveMtDataset": { @@ -1875,6 +1875,10 @@ "$ref": "GlossaryConfig", "description": "Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned." }, + "mimeType": { + "description": "The format of the source text. Currently only text/plain is supported.", + "type": "string" + }, "referenceSentenceConfig": { "$ref": "ReferenceSentenceConfig", "description": "Configuration for caller provided reference sentences." diff --git a/discovery/translate-v3beta1.json b/discovery/translate-v3beta1.json index 2b0660a5f32..a3e6e77a17a 100644 --- a/discovery/translate-v3beta1.json +++ b/discovery/translate-v3beta1.json @@ -358,7 +358,7 @@ ] }, "list": { - "description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.", + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v3beta1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "translate.projects.locations.list", @@ -367,7 +367,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -787,7 +787,7 @@ } } }, - "revision": "20260128", + "revision": "20260814", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchDocumentInputConfig": { diff --git a/discovery/travelimpactmodel-v1.json b/discovery/travelimpactmodel-v1.json index 6d0abb3a666..6d793b98327 100644 --- a/discovery/travelimpactmodel-v1.json +++ b/discovery/travelimpactmodel-v1.json @@ -161,7 +161,7 @@ } } }, - "revision": "20260624", + "revision": "20260819", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeDetailedFlightEmissionsRequest": { @@ -407,11 +407,11 @@ "type": "object" }, "EmissionsProvenance": { - "description": "Information about the provenance of the data used to calculate emissions estimates, including contributing factors and their data sources.", + "description": "Information about the provenance of the data used to calculate emissions estimates, including contributing factors and their data sources. In `provenance_entries`, `provenance_entry_type` acts as the \"key\" identifying the contributing factor, and there is always only one entry per entry type. The remaining fields in each entry describe that specific entry type and may or may not be populated depending on the contributing factor and available data.", "id": "EmissionsProvenance", "properties": { "provenanceEntries": { - "description": "Output only. All contributing factors used to calculate emissions.", + "description": "Output only. All contributing factors used to calculate emissions. Each entry type (`provenance_entry_type`) acts as a \"key\" identifying the factor, with always only one entry per entry type. The remaining fields describe that specific factor and may or may not be populated.", "items": { "$ref": "EmissionsProvenanceEntry" }, @@ -422,7 +422,7 @@ "type": "object" }, "EmissionsProvenanceEntry": { - "description": "Details about a single contributing factor in emissions calculations.", + "description": "Details about a single contributing factor in emissions calculations. Each entry represents a single factor where `provenance_entry_type` acts as the key identifying the factor, and the other fields describe it and may or may not be populated.", "id": "EmissionsProvenanceEntry", "properties": { "cargoMassFractionData": { @@ -546,7 +546,7 @@ "type": "string" }, "provenanceEntryType": { - "description": "Output only. The type of the provenance entry.", + "description": "Output only. The type of the provenance entry. Acts as the \"key\" identifying the contributing factor; the remaining fields in this message describe it and may or may not be populated.", "enum": [ "EMISSIONS_PROVENANCE_ENTRY_TYPE_UNSPECIFIED", "FUEL_BURN", diff --git a/discovery/webcontentpublisher-v1.json b/discovery/webcontentpublisher-v1.json index 2e57068b67b..3e965c9dfb8 100644 --- a/discovery/webcontentpublisher-v1.json +++ b/discovery/webcontentpublisher-v1.json @@ -376,7 +376,10 @@ }, "response": { "$ref": "Cta" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage" + ] } } } @@ -449,12 +452,16 @@ }, "response": { "$ref": "GeneratePlatformSiteTokensResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage", + "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly" + ] } } } }, - "revision": "20260812", + "revision": "20260819", "rootUrl": "https://webcontentpublisher.googleapis.com/", "schemas": { "CheckFreeAccessResponse": { diff --git a/discovery/workspaceevents-v1.json b/discovery/workspaceevents-v1.json index 6a87238c1d8..a1b7ffc1913 100644 --- a/discovery/workspaceevents-v1.json +++ b/discovery/workspaceevents-v1.json @@ -809,7 +809,7 @@ } } }, - "revision": "20260721", + "revision": "20260818", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "Artifact": { @@ -900,7 +900,7 @@ "id": "DriveOptions", "properties": { "includeDescendants": { - "description": "Optional. Immutable. For subscriptions to Google Drive events, whether to receive events about Drive files that are children of the target folder or shared drive. * If `false`, the subscription only receives events about changes to the folder or shared drive that's specified as the `targetResource`. * If `true`, the `mimeType` field of the `file` resource must be set to `application/vnd.google-apps.folder`. For details, see [Google Drive event types](https://developers.google.com/workspace/events/guides/events-drive#event-types).", + "description": "Optional. Immutable. For subscriptions to Google Drive events, whether to receive events about Drive files that are children of the target folder or shared drive. This field must be `true` for subscriptions on shared drives. * If `false`, the subscription only receives events about changes to the folder or shared drive that's specified as the `targetResource`. * If `true`, the `mimeType` field of the `file` resource must be set to `application/vnd.google-apps.folder`. For details, see [Google Drive event types](https://developers.google.com/workspace/events/guides/events-drive#event-types).", "type": "boolean" } }, diff --git a/discovery/youtube-v3.json b/discovery/youtube-v3.json index 3f7b7eabdea..28b86fa88d2 100644 --- a/discovery/youtube-v3.json +++ b/discovery/youtube-v3.json @@ -4192,7 +4192,7 @@ } } }, - "revision": "20260810", + "revision": "20260820", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -8740,6 +8740,10 @@ "format": "date-time", "type": "string" }, + "categoryId": { + "description": "The YouTube video category associated with the video broadcast.", + "type": "string" + }, "channelId": { "description": "The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.", "type": "string" @@ -11313,6 +11317,10 @@ "$ref": "Thumbnail", "description": "The default image for this resource." }, + "fhd": { + "$ref": "Thumbnail", + "description": "The full high definition (1080p) quality image for this resource." + }, "high": { "$ref": "Thumbnail", "description": "The high quality image for this resource." @@ -11325,9 +11333,17 @@ "$ref": "Thumbnail", "description": "The medium quality image for this resource." }, + "qhd": { + "$ref": "Thumbnail", + "description": "The quad high definition (1440p / 2K) quality image for this resource." + }, "standard": { "$ref": "Thumbnail", "description": "The standard quality image for this resource." + }, + "uhd": { + "$ref": "Thumbnail", + "description": "The ultra-high resolution (4K) quality image for this resource." } }, "type": "object" diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index bc9c51b4c6b..0a39d761e52 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -341,7 +341,7 @@ export namespace accesscontextmanager_v1 { */ restrictedClientApplication?: Schema$Application; /** - * Optional. The GCP project that is subject to this binding's scope. + * Optional. The Google Cloud project that is subject to this binding's scope. */ restrictedProject?: Schema$Project; } @@ -860,7 +860,7 @@ export namespace accesscontextmanager_v1 { */ export interface Schema$Principal { /** - * Immutable. IAM federated principal name to assign policies to workforce/workload federated identities. Can be principal set or single principal, here are some examples: Single principal: principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\} PrincipalSet: principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x + * Immutable. The IAM principal identifier of the federated workforce or workload to assign the policy to. Examples include the following: * Single principal: `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}` * All workloads in a workload identity pool: `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x` * All Workforce Pools in a Google Cloud organization: `principalSet://cloudresourcemanager.googleapis.com/organizations/{organization_id\}/type/WorkforcePool` Bindings created for all Workforce Pools in a Google Cloud organization support only `scoped_access_settings` with the `restricted_project` client scope and active `session_settings`. No other configurations are allowed. */ federatedPrincipal?: string | null; /** @@ -882,11 +882,11 @@ export namespace accesscontextmanager_v1 { forwardingRule?: string | null; } /** - * A GCP project which contains applications and resources that users can access. + * A Google Cloud project which contains applications and resources that users can access. */ export interface Schema$Project { /** - * The GCP project resource name. Format: "projects/{project_number\}" (Only the numeric project name variation is supported). Example: "projects/1234567890" + * The Google Cloud project resource name. Format: `projects/{project_number\}`. Only the project number is supported. Example: `projects/1234567890` */ name?: string | null; } @@ -1043,7 +1043,7 @@ export namespace accesscontextmanager_v1 { */ maxInactivity?: string | null; /** - * Optional. The session length. Setting this field to zero allows for sessions that are active indefinitely. Also, setting `session_length_enabled` to false disregards session limits, which means that sessions never expire. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and the OIDC max_age param. If this field is set to zero, `session_length_enabled` must be set to false or left unset. + * Optional. The session length. Setting this field to zero allows for sessions that are active indefinitely. Also, setting `session_length_enabled` to `false` disregards session limits, which means that sessions never expire. If `use_oidc_max_age` is `true`, for OIDC apps, the session length will be the minimum of this field and the OIDC `max_age` param. If this field is set to zero, `session_length_enabled` must be set to `false` or left unset. */ sessionLength?: string | null; /** @@ -4853,6 +4853,8 @@ export namespace accesscontextmanager_v1 { * * // Do the magic * const res = await accesscontextmanager.accessPolicies.servicePerimeters.get({ + * // Optional. If true, the response will contain the deleted principal syntax for identities that support it. + * deletedPrincipalSyntax: 'placeholder-value', * // Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id\}/servicePerimeters/{service_perimeters_id\}` * name: 'accessPolicies/my-accessPolicie/servicePerimeters/my-servicePerimeter', * }); @@ -4995,6 +4997,8 @@ export namespace accesscontextmanager_v1 { * * // Do the magic * const res = await accesscontextmanager.accessPolicies.servicePerimeters.list({ + * // Optional. If true, the response will contain the deleted principal syntax for identities that support it. + * deletedPrincipalSyntax: 'placeholder-value', * // Number of Service Perimeters to include in the list. Default 100. * pageSize: 'placeholder-value', * // Next page token for the next batch of Service Perimeter instances. Defaults to the first page of results. @@ -5145,6 +5149,8 @@ export namespace accesscontextmanager_v1 { * // Do the magic * const res = await accesscontextmanager.accessPolicies.servicePerimeters.patch( * { + * // Optional. If true, the response will contain the deleted principal syntax for identities that support it and the request can contain identities with deleted principal syntax. + * deletedPrincipalSyntax: 'placeholder-value', * // Identifier. Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy\}/servicePerimeters/{service_perimeter\}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `name`. * name: 'accessPolicies/my-accessPolicie/servicePerimeters/my-servicePerimeter', * // Required. Mask to control which fields get updated. Must be non-empty. @@ -5605,12 +5611,20 @@ export namespace accesscontextmanager_v1 { name?: string; } export interface Params$Resource$Accesspolicies$Serviceperimeters$Get extends StandardParameters { + /** + * Optional. If true, the response will contain the deleted principal syntax for identities that support it. + */ + deletedPrincipalSyntax?: string; /** * Required. Resource name for the Service Perimeter. Format: `accessPolicies/{policy_id\}/servicePerimeters/{service_perimeters_id\}` */ name?: string; } export interface Params$Resource$Accesspolicies$Serviceperimeters$List extends StandardParameters { + /** + * Optional. If true, the response will contain the deleted principal syntax for identities that support it. + */ + deletedPrincipalSyntax?: string; /** * Number of Service Perimeters to include in the list. Default 100. */ @@ -5625,6 +5639,10 @@ export namespace accesscontextmanager_v1 { parent?: string; } export interface Params$Resource$Accesspolicies$Serviceperimeters$Patch extends StandardParameters { + /** + * Optional. If true, the response will contain the deleted principal syntax for identities that support it and the request can contain identities with deleted principal syntax. + */ + deletedPrincipalSyntax?: string; /** * Identifier. Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy\}/servicePerimeters/{service_perimeter\}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `name`. */ diff --git a/src/apis/agentidentitycredentials/v1.ts b/src/apis/agentidentitycredentials/v1.ts index 29c41a39b68..31d286f9205 100644 --- a/src/apis/agentidentitycredentials/v1.ts +++ b/src/apis/agentidentitycredentials/v1.ts @@ -102,7 +102,7 @@ export namespace agentidentitycredentials_v1 { /** * Agent Identity Credentials API * - * agentidentitycredentials.googleapis.com API. + * The Agent Identity Credentials API retrieves and finalizes authorization credentials for auth providers. * * @example * ```js @@ -125,15 +125,15 @@ export namespace agentidentitycredentials_v1 { } /** - * Indicates the user has rejected the permission delegation or cancelled the request. + * Indicates the user has rejected the permission delegation or canceled the request. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1_ConsentRejected {} /** - * Request message for FinalizeCredentials. + * Request message for `FinalizeCredentials`. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsRequest { /** - * Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata. + * Required. The same `consent_nonce` value that was provided during retrieval in the [UriConsentRequired](https://cloud.google.com/iam/docs/reference/agentidentitycredentials/rest/v1/projects.locations.authProviders.credentials/retrieve#UriConsentRequired) metadata. */ consentNonce?: string | null; /** @@ -146,23 +146,23 @@ export namespace agentidentitycredentials_v1 { userIdValidationState?: string | null; } /** - * Response message for FinalizeCredentials. Intentionally empty + * Response message for `FinalizeCredentials`. Intentionally empty. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1_FinalizeCredentialsResponse {} /** - * Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time. + * Indicates that the credential retrieval is pending. The caller should retry the `RetrieveCredentials` request after some time. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1_Pending {} /** - * Request message for RetrieveCredentials. + * Request message for `RetrieveCredentials`. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsRequest { /** - * Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected. + * Optional. The URI to redirect the user to after consent is completed. This field is required for auth providers using the 3-legged OAuth flow. For other auth provider types, this field is unused but not rejected. */ continueUri?: string | null; /** - * Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow. + * Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Setting this field triggers a refresh of the access token with a stored refresh token, if possible, or a new consent flow. */ forceRefreshToken?: string | null; /** @@ -175,7 +175,7 @@ export namespace agentidentitycredentials_v1 { userId?: string | null; } /** - * Response message for RetrieveCredentials. Contains the access tokens and related artifacts. + * Response message for `RetrieveCredentials`. Contains the access tokens and related artifacts. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1_RetrieveCredentialsResponse { /** @@ -191,7 +191,7 @@ export namespace agentidentitycredentials_v1 { */ success?: Schema$GoogleCloudAgentidentitycredentialsV1_Success; /** - * Message indicating uri based consent is required. + * Message indicating URI-based consent is required. */ uriConsentRequired?: Schema$GoogleCloudAgentidentitycredentialsV1_UriConsentRequired; } @@ -212,12 +212,12 @@ export namespace agentidentitycredentials_v1 { */ scopes?: string[] | null; /** - * The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow. + * The retrieved access token or credential for the end user. On an MCP tool call, for an invalid token the OAuth spec states that this should return `401` or `403`, but MCP servers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to `RetrieveCredentials` with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow. */ token?: string | null; } /** - * Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback + * Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1_UriConsentRequired { /** @@ -225,7 +225,7 @@ export namespace agentidentitycredentials_v1 { */ authorizationUri?: string | null; /** - * Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5 + * Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the `FinalizeCredentials` request to complete the OAuth exchange. This will always be present. Implemented per [RFC 6819 Section 5.3.5](https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5). */ consentNonce?: string | null; /** @@ -303,7 +303,7 @@ export namespace agentidentitycredentials_v1 { * const res = * await agentidentitycredentials.projects.locations.authProviders.credentials.finalize( * { - * // Required. The resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * // Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` * authProvider: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * @@ -432,7 +432,7 @@ export namespace agentidentitycredentials_v1 { } /** - * Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information. + * Retrieves authorization credentials for an auth provider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `result` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information. * @example * ```js * // Before running the sample: @@ -464,7 +464,7 @@ export namespace agentidentitycredentials_v1 { * const res = * await agentidentitycredentials.projects.locations.authProviders.credentials.retrieve( * { - * // Required. The parent resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * // Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` * authProvider: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * @@ -601,7 +601,7 @@ export namespace agentidentitycredentials_v1 { export interface Params$Resource$Projects$Locations$Authproviders$Credentials$Finalize extends StandardParameters { /** - * Required. The resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` */ authProvider?: string; @@ -612,7 +612,7 @@ export namespace agentidentitycredentials_v1 { } export interface Params$Resource$Projects$Locations$Authproviders$Credentials$Retrieve extends StandardParameters { /** - * Required. The parent resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` */ authProvider?: string; diff --git a/src/apis/agentidentitycredentials/v1alpha.ts b/src/apis/agentidentitycredentials/v1alpha.ts index 8c8a06555a7..25cb1655a9b 100644 --- a/src/apis/agentidentitycredentials/v1alpha.ts +++ b/src/apis/agentidentitycredentials/v1alpha.ts @@ -102,7 +102,7 @@ export namespace agentidentitycredentials_v1alpha { /** * Agent Identity Credentials API * - * agentidentitycredentials.googleapis.com API. + * The Agent Identity Credentials API retrieves and finalizes authorization credentials for auth providers. * * @example * ```js @@ -125,15 +125,15 @@ export namespace agentidentitycredentials_v1alpha { } /** - * Indicates the user has rejected the permission delegation or cancelled the request. + * Indicates the user has rejected the permission delegation or canceled the request. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1alpha_ConsentRejected {} /** - * Request message for FinalizeCredentials. + * Request message for `FinalizeCredentials`. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsRequest { /** - * Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata. + * Required. The same `consent_nonce` value that was provided during retrieval in the [UriConsentRequired](https://cloud.google.com/iam/docs/reference/agentidentitycredentials/rest/v1/projects.locations.authProviders.credentials/retrieve#UriConsentRequired) metadata. */ consentNonce?: string | null; /** @@ -146,23 +146,23 @@ export namespace agentidentitycredentials_v1alpha { userIdValidationState?: string | null; } /** - * Response message for FinalizeCredentials. Intentionally empty + * Response message for `FinalizeCredentials`. Intentionally empty. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1alpha_FinalizeCredentialsResponse {} /** - * Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time. + * Indicates that the credential retrieval is pending. The caller should retry the `RetrieveCredentials` request after some time. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1alpha_Pending {} /** - * Request message for RetrieveCredentials. + * Request message for `RetrieveCredentials`. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsRequest { /** - * Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected. + * Optional. The URI to redirect the user to after consent is completed. This field is required for auth providers using the 3-legged OAuth flow. For other auth provider types, this field is unused but not rejected. */ continueUri?: string | null; /** - * Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow. + * Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Setting this field triggers a refresh of the access token with a stored refresh token, if possible, or a new consent flow. */ forceRefreshToken?: string | null; /** @@ -175,7 +175,7 @@ export namespace agentidentitycredentials_v1alpha { userId?: string | null; } /** - * Response message for RetrieveCredentials. Contains the access tokens and related artifacts. + * Response message for `RetrieveCredentials`. Contains the access tokens and related artifacts. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1alpha_RetrieveCredentialsResponse { /** @@ -191,7 +191,7 @@ export namespace agentidentitycredentials_v1alpha { */ success?: Schema$GoogleCloudAgentidentitycredentialsV1alpha_Success; /** - * Message indicating uri based consent is required. + * Message indicating URI-based consent is required. */ uriConsentRequired?: Schema$GoogleCloudAgentidentitycredentialsV1alpha_UriConsentRequired; } @@ -212,12 +212,12 @@ export namespace agentidentitycredentials_v1alpha { */ scopes?: string[] | null; /** - * The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow. + * The retrieved access token or credential for the end user. On an MCP tool call, for an invalid token the OAuth spec states that this should return `401` or `403`, but MCP servers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to `RetrieveCredentials` with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow. */ token?: string | null; } /** - * Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback + * Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1alpha_UriConsentRequired { /** @@ -225,7 +225,7 @@ export namespace agentidentitycredentials_v1alpha { */ authorizationUri?: string | null; /** - * Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5 + * Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the `FinalizeCredentials` request to complete the OAuth exchange. This will always be present. Implemented per [RFC 6819 Section 5.3.5](https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5). */ consentNonce?: string | null; /** @@ -303,7 +303,7 @@ export namespace agentidentitycredentials_v1alpha { * const res = * await agentidentitycredentials.projects.locations.authProviders.credentials.finalize( * { - * // Required. The resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * // Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` * authProvider: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * @@ -431,7 +431,7 @@ export namespace agentidentitycredentials_v1alpha { } /** - * Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information. + * Retrieves authorization credentials for an auth provider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `result` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information. * @example * ```js * // Before running the sample: @@ -463,7 +463,7 @@ export namespace agentidentitycredentials_v1alpha { * const res = * await agentidentitycredentials.projects.locations.authProviders.credentials.retrieve( * { - * // Required. The parent resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * // Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` * authProvider: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * @@ -599,7 +599,7 @@ export namespace agentidentitycredentials_v1alpha { export interface Params$Resource$Projects$Locations$Authproviders$Credentials$Finalize extends StandardParameters { /** - * Required. The resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` */ authProvider?: string; @@ -610,7 +610,7 @@ export namespace agentidentitycredentials_v1alpha { } export interface Params$Resource$Projects$Locations$Authproviders$Credentials$Retrieve extends StandardParameters { /** - * Required. The parent resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` */ authProvider?: string; diff --git a/src/apis/agentidentitycredentials/v1beta.ts b/src/apis/agentidentitycredentials/v1beta.ts index 885379344b5..ec11025aeba 100644 --- a/src/apis/agentidentitycredentials/v1beta.ts +++ b/src/apis/agentidentitycredentials/v1beta.ts @@ -102,7 +102,7 @@ export namespace agentidentitycredentials_v1beta { /** * Agent Identity Credentials API * - * agentidentitycredentials.googleapis.com API. + * The Agent Identity Credentials API retrieves and finalizes authorization credentials for auth providers. * * @example * ```js @@ -125,15 +125,15 @@ export namespace agentidentitycredentials_v1beta { } /** - * Indicates the user has rejected the permission delegation or cancelled the request. + * Indicates the user has rejected the permission delegation or canceled the request. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1beta_ConsentRejected {} /** - * Request message for FinalizeCredentials. + * Request message for `FinalizeCredentials`. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsRequest { /** - * Required. The same consent_nonce value that was provided during redirect in the UriConsentRequired metadata. + * Required. The same `consent_nonce` value that was provided during retrieval in the [UriConsentRequired](https://cloud.google.com/iam/docs/reference/agentidentitycredentials/rest/v1/projects.locations.authProviders.credentials/retrieve#UriConsentRequired) metadata. */ consentNonce?: string | null; /** @@ -146,23 +146,23 @@ export namespace agentidentitycredentials_v1beta { userIdValidationState?: string | null; } /** - * Response message for FinalizeCredentials. Intentionally empty + * Response message for `FinalizeCredentials`. Intentionally empty. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1beta_FinalizeCredentialsResponse {} /** - * Indicates that the credential retrieval is pending. The caller should retry the RetrieveCredentials request after some time. + * Indicates that the credential retrieval is pending. The caller should retry the `RetrieveCredentials` request after some time. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1beta_Pending {} /** - * Request message for RetrieveCredentials. + * Request message for `RetrieveCredentials`. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsRequest { /** - * Optional. The URI to redirect the user to after consent is completed. This field is required for authproviders using the 3-legged OAuth flow. For other authprovider types, this field is unused but not rejected. + * Optional. The URI to redirect the user to after consent is completed. This field is required for auth providers using the 3-legged OAuth flow. For other auth provider types, this field is unused but not rejected. */ continueUri?: string | null; /** - * Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Will trigger a refresh of the access token with a stored refresh token, if possible, or a new consent flow. + * Optional. Input only. Set this field only if the previous token was expired or invalid. This value must be the full, previously returned token string. Setting this field triggers a refresh of the access token with a stored refresh token, if possible, or a new consent flow. */ forceRefreshToken?: string | null; /** @@ -175,7 +175,7 @@ export namespace agentidentitycredentials_v1beta { userId?: string | null; } /** - * Response message for RetrieveCredentials. Contains the access tokens and related artifacts. + * Response message for `RetrieveCredentials`. Contains the access tokens and related artifacts. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1beta_RetrieveCredentialsResponse { /** @@ -191,7 +191,7 @@ export namespace agentidentitycredentials_v1beta { */ success?: Schema$GoogleCloudAgentidentitycredentialsV1beta_Success; /** - * Message indicating uri based consent is required. + * Message indicating URI-based consent is required. */ uriConsentRequired?: Schema$GoogleCloudAgentidentitycredentialsV1beta_UriConsentRequired; } @@ -212,12 +212,12 @@ export namespace agentidentitycredentials_v1beta { */ scopes?: string[] | null; /** - * The retrieved access token or credential for the end user. On MCPTool call, for an invalid token OAuth spec says this should return 401 or 403, but MCPServers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to RetrieveCredentials with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow. + * The retrieved access token or credential for the end user. On an MCP tool call, for an invalid token the OAuth spec states that this should return `401` or `403`, but MCP servers may implement this differently. If you get any flavor of `PERMISSION_DENIED`, retry your original request to `RetrieveCredentials` with force_refresh_token set to the expired/invalid token string, which will fetch a new token or initiate a new consent flow. */ token?: string | null; } /** - * Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback + * Indicates that the user must visit the provided URI to consent to delegate permission to the agent to act on their behalf. The caller can either poll the `RetrieveCredentials` method, or await the /ValidateUserId callback. */ export interface Schema$GoogleCloudAgentidentitycredentialsV1beta_UriConsentRequired { /** @@ -225,7 +225,7 @@ export namespace agentidentitycredentials_v1beta { */ authorizationUri?: string | null; /** - * Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the FinalizeCredentials request to complete the OAuth exchange. This will always be present. Implemented per https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5 + * Output only. A one-time, randomly generated value that validates the entire consent flow is handled by a single user, avoiding CSRF attacks. It must be submitted with the `FinalizeCredentials` request to complete the OAuth exchange. This will always be present. Implemented per [RFC 6819 Section 5.3.5](https://www.rfc-editor.org/rfc/rfc6819#section-5.3.5). */ consentNonce?: string | null; /** @@ -303,7 +303,7 @@ export namespace agentidentitycredentials_v1beta { * const res = * await agentidentitycredentials.projects.locations.authProviders.credentials.finalize( * { - * // Required. The resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * // Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` * authProvider: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * @@ -431,7 +431,7 @@ export namespace agentidentitycredentials_v1beta { } /** - * Retrieves authorization credentials for an authprovider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `status` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information. + * Retrieves authorization credentials for an auth provider, or indicates what action needs to be taken to obtain credentials. If the `token` field in the response is populated, credential retrieval was successful. If one of the fields in the `result` oneof is populated, further action is required to obtain credentials, such as redirecting the user for consent. View comments on `RetrieveCredentialsResponse` for more information. * @example * ```js * // Before running the sample: @@ -463,7 +463,7 @@ export namespace agentidentitycredentials_v1beta { * const res = * await agentidentitycredentials.projects.locations.authProviders.credentials.retrieve( * { - * // Required. The parent resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * // Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` * authProvider: * 'projects/my-project/locations/my-location/authProviders/my-authProvider', * @@ -599,7 +599,7 @@ export namespace agentidentitycredentials_v1beta { export interface Params$Resource$Projects$Locations$Authproviders$Credentials$Finalize extends StandardParameters { /** - * Required. The resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` */ authProvider?: string; @@ -610,7 +610,7 @@ export namespace agentidentitycredentials_v1beta { } export interface Params$Resource$Projects$Locations$Authproviders$Credentials$Retrieve extends StandardParameters { /** - * Required. The parent resource name of the AuthProvider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` + * Required. The resource name of the auth provider. Format: `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}` */ authProvider?: string; diff --git a/src/apis/agentregistry/v1alpha.ts b/src/apis/agentregistry/v1alpha.ts index cce67684a87..e98cf882cba 100644 --- a/src/apis/agentregistry/v1alpha.ts +++ b/src/apis/agentregistry/v1alpha.ts @@ -5621,7 +5621,7 @@ export namespace agentregistry_v1alpha { * parent: 'projects/my-project/locations/my-location', * // Optional. Signed UUID request idempotency token. * requestId: 'placeholder-value', - * // Required. Custom, user-defined unique container identifier. Must be unique within the parent project and location. This value should be 4-63 characters, and valid characters are `/a-z-/`. + * // Required. Custom, user-defined unique container identifier. Must be unique within the parent project and location. This value should be 4-64 characters, and valid characters are `/a-z-/`. * skillId: 'placeholder-value', * * // Request body metadata @@ -6538,7 +6538,7 @@ export namespace agentregistry_v1alpha { */ requestId?: string; /** - * Required. Custom, user-defined unique container identifier. Must be unique within the parent project and location. This value should be 4-63 characters, and valid characters are `/a-z-/`. + * Required. Custom, user-defined unique container identifier. Must be unique within the parent project and location. This value should be 4-64 characters, and valid characters are `/a-z-/`. */ skillId?: string; diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 0d7299c5d43..89b2ac8f3d9 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -128,6 +128,9 @@ export namespace alloydb_v1 { * AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo. */ export interface Schema$AlloydbClhErrorsAlloyDbInternalDebugInfo { + /** + * The original error message or details before sanitization, used internally for debugging and logging. + */ originalError?: string | null; } /** diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 52e6ccbd03b..0a6372b0efc 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -128,6 +128,9 @@ export namespace alloydb_v1alpha { * AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo. */ export interface Schema$AlloydbClhErrorsAlloyDbInternalDebugInfo { + /** + * The original error message or details before sanitization, used internally for debugging and logging. + */ originalError?: string | null; } /** diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 94b2b721355..ea882ffd015 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -128,6 +128,9 @@ export namespace alloydb_v1beta { * AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo. */ export interface Schema$AlloydbClhErrorsAlloyDbInternalDebugInfo { + /** + * The original error message or details before sanitization, used internally for debugging and logging. + */ originalError?: string | null; } /** diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index 19d09e22284..6b275de2cff 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -220,7 +220,7 @@ export namespace androiddeviceprovisioning_v1 { */ ownerEmails?: string[] | null; /** - * Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer. + * Input only. Deprecated: This field is no longer supported and is ignored by the server. */ skipWelcomeEmail?: boolean | null; /** diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 1d8693ef194..e6b3eda02f1 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -114,6 +114,7 @@ export namespace androidpublisher_v3 { context: APIRequestContext; applications: Resource$Applications; apprecovery: Resource$Apprecovery; + appsigning: Resource$Appsigning; appstoreappsreview: Resource$Appstoreappsreview; appstorecatalog: Resource$Appstorecatalog; edits: Resource$Edits; @@ -137,6 +138,7 @@ export namespace androidpublisher_v3 { this.applications = new Resource$Applications(this.context); this.apprecovery = new Resource$Apprecovery(this.context); + this.appsigning = new Resource$Appsigning(this.context); this.appstoreappsreview = new Resource$Appstoreappsreview(this.context); this.appstorecatalog = new Resource$Appstorecatalog(this.context); this.edits = new Resource$Edits(this.context); @@ -1310,6 +1312,45 @@ export namespace androidpublisher_v3 { */ targetSdkVersion?: string | null; } + /** + * Hash digests of a certificate. + */ + export interface Schema$CertificateHashes { + /** + * Hex-encoded MD5 hash of the certificate. example: `43:51:43:A1:B5:FC:8B:B7:0A:3A:A9:B1:0F:66:73:A8` + */ + certificateHashMd5?: string | null; + /** + * Hex-encoded SHA1 hash of the certificate. example: `86:61:97:1A:D5:EF:E5:74:1E:A7:5B:84:7C:68:37:65:CD:94:16:DE` + */ + certificateHashSha1?: string | null; + /** + * Hex-encoded SHA256 hash of the certificate. example: `94:49:C7:F3:A9:3C:F0:C5:5A:67:5D:DF:1C:83:73:2D:87:D5:62:55:E7:0B:15:0D:9E:6F:3C:F8:63:BB:7F:C1` + */ + certificateHashSha256?: string | null; + } + /** + * Reference to a private key hosted in developer-managed Google Cloud KMS. + */ + export interface Schema$CloudKmsKey { + /** + * Required. Resource identifier of the private key hosted in Google Cloud KMS. The Google Play service account must be granted Decrypt and Sign permissions on this resource. Format: projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/ + */ + cryptoKeyVersionResource?: string | null; + } + /** + * Cloud KMS key and the certificate associated with the key. + */ + export interface Schema$CloudKmsKeyAndCert { + /** + * Required. Cloud KMS key. + */ + cloudKmsKey?: Schema$CloudKmsKey; + /** + * Required. Certificate associated with the key. The bytes must contain the certificate in PEM format. + */ + pemCertificate?: string | null; + } /** * Coarse Geographic location details for where the consumption happened. */ @@ -2042,6 +2083,54 @@ export namespace androidpublisher_v3 { */ deviceTiers?: Schema$DeviceTier[]; } + /** + * Request to enroll an app into Play App Signing using a self-hosted Cloud KMS key. + */ + export interface Schema$EnrollAppRequest { + /** + * Enrolls an existing app into Play signing using an external Cloud KMS key. + */ + enrollExistingApp?: Schema$EnrollExistingApp; + /** + * Changes the signing key of a new app to an external Cloud KMS key. The app must not have published to Open testing or Production tracks. + */ + enrollNewApp?: Schema$EnrollNewApp; + /** + * The certificate associated with the upload key, in PEM format. + */ + pemUploadCertificate?: string | null; + } + /** + * Response to enroll an app into Play signing. + */ + export interface Schema$EnrollAppResponse { + /** + * The signing certificate hashes for the app. Always set. + */ + signingCertificate?: Schema$CertificateHashes; + /** + * The upload certificate hashes for the app. Set iff pem_upload_certificate was set in the request. + */ + uploadCertificate?: Schema$CertificateHashes; + } + /** + * Enroll an existing app into Play signing. + */ + export interface Schema$EnrollExistingApp { + /** + * Required. Self-hosted key. Once enrolled, this key will be used to sign your app. + */ + cloudKmsKey?: Schema$CloudKmsKey; + } + /** + * Enroll a new app into Play signing. + */ + export interface Schema$EnrollNewApp { + /** + * Required. Self-hosted key. Once enrolled, this key will be used to sign your app. + */ + cloudKmsKeyAndCert?: Schema$CloudKmsKeyAndCert; + } /** * An expansion file. The resource for ExpansionFilesService. */ @@ -4820,6 +4909,41 @@ export namespace androidpublisher_v3 { * Response for the purchases.subscriptionsv2.revoke API. */ export interface Schema$RevokeSubscriptionPurchaseResponse {} + /** + * Request to rotate an app's signing key. + */ + export interface Schema$RotateAppSigningKeyRequest { + /** + * Required. Reason for rotating the app key. + */ + keyRotationReason?: string | null; + /** + * Required. Self-hosted Cloud KMS key. + */ + rotatedCloudKmsKey?: Schema$RotatedCloudKmsKey; + } + /** + * Response to rotate an app's signing key. + */ + export interface Schema$RotateAppSigningKeyResponse { + /** + * The rotated key certificate hashes for the app. Always set. + */ + rotatedKeyCertificate?: Schema$CertificateHashes; + } + /** + * Message representing rotated Cloud KMS key. Consists of the Cloud KMS key and its associated proof of rotation. + */ + export interface Schema$RotatedCloudKmsKey { + /** + * Required. Cloud KMS key and the certificate associated with the key. + */ + cloudKmsKeyAndCert?: Schema$CloudKmsKeyAndCert; + /** + * Required. Proof-of-rotation. See [creating signing certificate lineages](https://developer.android.com/studio/command-line/apksigner#rotate_signing_keys_2). + */ + signingCertificateLineage?: string | null; + } /** * Request to update Safety Labels of an app. */ @@ -7836,6 +7960,336 @@ export namespace androidpublisher_v3 { versionCode?: string; } + export class Resource$Appsigning { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Enrolls an app in Play App Signing using a self-hosted Google Cloud KMS key. Warning: Do not use this method for standard Play App Signing enrollment. * Standard enrollment with Google-generated or Google-managed keys cannot be done via API. * This advanced API is strictly for enterprise organizations with mandatory compliance, regulatory, or policy requirements to retain key custody in an external Google Cloud KMS instance. * Prerequisites: Requires an active, properly configured Google Cloud KMS key with appropriate IAM permissions granted to Google Play before calling this method. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756 + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/androidpublisher.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const androidpublisher = google.androidpublisher('v3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/androidpublisher'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await androidpublisher.appsigning.enrollApp({ + * // Required. Either package name or app ID of the app enrolling in Play Signing. + * name: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "enrollExistingApp": {}, + * // "enrollNewApp": {}, + * // "pemUploadCertificate": "my_pemUploadCertificate" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "signingCertificate": {}, + * // "uploadCertificate": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + enrollApp( + params: Params$Resource$Appsigning$Enrollapp, + options: StreamMethodOptions + ): Promise>; + enrollApp( + params?: Params$Resource$Appsigning$Enrollapp, + options?: MethodOptions + ): Promise>; + enrollApp( + params: Params$Resource$Appsigning$Enrollapp, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enrollApp( + params: Params$Resource$Appsigning$Enrollapp, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enrollApp( + params: Params$Resource$Appsigning$Enrollapp, + callback: BodyResponseCallback + ): void; + enrollApp(callback: BodyResponseCallback): void; + enrollApp( + paramsOrCallback?: + | Params$Resource$Appsigning$Enrollapp + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Appsigning$Enrollapp; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Appsigning$Enrollapp; + 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/{name}/appSigning:enrollApp' + ).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); + } + } + + /** + * Rotates an app's signing key to a new self-hosted Google Cloud KMS key. Warning: This method only applies to apps enrolled with self-hosted Cloud KMS keys. For apps using standard Google-managed Play App Signing, key rotation requests must be initiated through the Google Play Console UI. See Help Center: https://support.google.com/googleplay/android-developer/answer/9842756 + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/androidpublisher.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const androidpublisher = google.androidpublisher('v3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/androidpublisher'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await androidpublisher.appsigning.rotateAppSigningKey({ + * // Required. Either package name or app ID of the app rotating the signing key. + * name: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "keyRotationReason": "my_keyRotationReason", + * // "rotatedCloudKmsKey": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "rotatedKeyCertificate": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + rotateAppSigningKey( + params: Params$Resource$Appsigning$Rotateappsigningkey, + options: StreamMethodOptions + ): Promise>; + rotateAppSigningKey( + params?: Params$Resource$Appsigning$Rotateappsigningkey, + options?: MethodOptions + ): Promise>; + rotateAppSigningKey( + params: Params$Resource$Appsigning$Rotateappsigningkey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rotateAppSigningKey( + params: Params$Resource$Appsigning$Rotateappsigningkey, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rotateAppSigningKey( + params: Params$Resource$Appsigning$Rotateappsigningkey, + callback: BodyResponseCallback + ): void; + rotateAppSigningKey( + callback: BodyResponseCallback + ): void; + rotateAppSigningKey( + paramsOrCallback?: + | Params$Resource$Appsigning$Rotateappsigningkey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Appsigning$Rotateappsigningkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Appsigning$Rotateappsigningkey; + 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/{name}/appSigning:rotateAppSigningKey' + ).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$Appsigning$Enrollapp extends StandardParameters { + /** + * Required. Either package name or app ID of the app enrolling in Play Signing. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EnrollAppRequest; + } + export interface Params$Resource$Appsigning$Rotateappsigningkey extends StandardParameters { + /** + * Required. Either package name or app ID of the app rotating the signing key. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RotateAppSigningKeyRequest; + } + export class Resource$Appstoreappsreview { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/apigeeregistry/v1.ts b/src/apis/apigeeregistry/v1.ts deleted file mode 100644 index 30124a9d34a..00000000000 --- a/src/apis/apigeeregistry/v1.ts +++ /dev/null @@ -1,17228 +0,0 @@ -// Copyright 2020 Google LLC -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -/* eslint-disable @typescript-eslint/no-explicit-any */ -/* eslint-disable @typescript-eslint/no-unused-vars */ -/* eslint-disable @typescript-eslint/no-empty-interface */ -/* eslint-disable @typescript-eslint/no-namespace */ -/* eslint-disable no-irregular-whitespace */ - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, - BaseExternalAccountClient, - GaxiosResponseWithHTTP2, - GoogleConfigurable, - createAPIRequest, - MethodOptions, - StreamMethodOptions, - GlobalOptions, - GoogleAuth, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {Readable} from 'stream'; - -export namespace apigeeregistry_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; - } - - /** - * Apigee Registry API - * - * - * - * @example - * ```js - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * ``` - */ - export class Apigeeregistry { - context: APIRequestContext; - projects: Resource$Projects; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.projects = new Resource$Projects(this.context); - } - } - - /** - * A top-level description of an API. Produced by producers and are commitments to provide services. - */ - export interface Schema$Api { - /** - * Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. - */ - annotations?: {[key: string]: string} | null; - /** - * A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN". - */ - availability?: string | null; - /** - * Output only. Creation timestamp. - */ - createTime?: string | null; - /** - * A detailed description. - */ - description?: string | null; - /** - * Human-meaningful name. - */ - displayName?: string | null; - /** - * Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. - */ - labels?: {[key: string]: string} | null; - /** - * Resource name. - */ - name?: string | null; - /** - * The recommended deployment of the API. Format: `projects/{project\}/locations/{location\}/apis/{api\}/deployments/{deployment\}` - */ - recommendedDeployment?: string | null; - /** - * The recommended version of the API. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}` - */ - recommendedVersion?: string | null; - /** - * Output only. Last update timestamp. - */ - updateTime?: string | null; - } - /** - * Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes. - */ - export interface Schema$ApiDeployment { - /** - * Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. - */ - accessGuidance?: string | null; - /** - * Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. - */ - annotations?: {[key: string]: string} | null; - /** - * The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec@revision\}` - */ - apiSpecRevision?: string | null; - /** - * Output only. Creation timestamp; when the deployment resource was created. - */ - createTime?: string | null; - /** - * A detailed description. - */ - description?: string | null; - /** - * Human-meaningful name. - */ - displayName?: string | null; - /** - * The address where the deployment is serving. Changes to this value will update the revision. - */ - endpointUri?: string | null; - /** - * The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision. - */ - externalChannelUri?: string | null; - /** - * Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. - */ - intendedAudience?: string | null; - /** - * Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. - */ - labels?: {[key: string]: string} | null; - /** - * Resource name. - */ - name?: string | null; - /** - * Output only. Revision creation timestamp; when the represented revision was created. - */ - revisionCreateTime?: string | null; - /** - * Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string. - */ - revisionId?: string | null; - /** - * Output only. Last update timestamp: when the represented revision was last modified. - */ - revisionUpdateTime?: string | null; - } - /** - * Describes a version of an API in a structured way. ApiSpecs provide formal descriptions that consumers can use to use a version. ApiSpec resources are intended to be fully-resolved descriptions of an ApiVersion. When specs consist of multiple files, these should be bundled together (e.g., in a zip archive) and stored as a unit. Multiple specs can exist to provide representations in different API description formats. Synchronization of these representations would be provided by tooling and background services. - */ - export interface Schema$ApiSpec { - /** - * Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. - */ - annotations?: {[key: string]: string} | null; - /** - * Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents. - */ - contents?: string | null; - /** - * Output only. Creation timestamp; when the spec resource was created. - */ - createTime?: string | null; - /** - * A detailed description. - */ - description?: string | null; - /** - * A possibly-hierarchical name used to refer to the spec from other specs. - */ - filename?: string | null; - /** - * Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec. - */ - hash?: string | null; - /** - * Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. - */ - labels?: {[key: string]: string} | null; - /** - * A style (format) descriptor for this spec that is specified as a [Media Type](https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). - */ - mimeType?: string | null; - /** - * Resource name. - */ - name?: string | null; - /** - * Output only. Revision creation timestamp; when the represented revision was created. - */ - revisionCreateTime?: string | null; - /** - * Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string. - */ - revisionId?: string | null; - /** - * Output only. Last update timestamp: when the represented revision was last modified. - */ - revisionUpdateTime?: string | null; - /** - * Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec. - */ - sizeBytes?: number | null; - /** - * The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved. - */ - sourceUri?: string | null; - } - /** - * Describes a particular version of an API. ApiVersions are what consumers actually use. - */ - export interface Schema$ApiVersion { - /** - * Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. - */ - annotations?: {[key: string]: string} | null; - /** - * Output only. Creation timestamp. - */ - createTime?: string | null; - /** - * A detailed description. - */ - description?: string | null; - /** - * Human-meaningful name. - */ - displayName?: string | null; - /** - * Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. - */ - labels?: {[key: string]: string} | null; - /** - * Resource name. - */ - name?: string | null; - /** - * The primary spec for this version. Format: projects/{project\}/locations/{location\}/apis/{api\}/versions/{version\}/specs/{spec\} - */ - primarySpec?: string | null; - /** - * A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED". - */ - state?: string | null; - /** - * Output only. Last update timestamp. - */ - updateTime?: string | null; - } - /** - * Artifacts of resources. Artifacts are unique (single-value) per resource and are used to store metadata that is too large or numerous to be stored directly on the resource. Since artifacts are stored separately from parent resources, they should generally be used for metadata that is needed infrequently, i.e., not for display in primary views of the resource but perhaps displayed or downloaded upon request. The `ListArtifacts` method allows artifacts to be quickly enumerated and checked for presence without downloading their (potentially-large) contents. - */ - export interface Schema$Artifact { - /** - * Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. - */ - annotations?: {[key: string]: string} | null; - /** - * Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents. - */ - contents?: string | null; - /** - * Output only. Creation timestamp. - */ - createTime?: string | null; - /** - * Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact. - */ - hash?: string | null; - /** - * Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "registry.googleapis.com/" and cannot be changed. - */ - labels?: {[key: string]: string} | null; - /** - * A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). - */ - mimeType?: string | null; - /** - * Resource name. - */ - name?: string | null; - /** - * Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact. - */ - sizeBytes?: number | null; - /** - * Output only. Last update timestamp. - */ - updateTime?: 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`. * `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. - */ - members?: string[] | null; - /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. - */ - role?: string | null; - } - /** - * Build information of the Instance if it's in `ACTIVE` state. - */ - export interface Schema$Build { - /** - * Output only. Commit ID of the latest commit in the build. - */ - commitId?: string | null; - /** - * Output only. Commit time of the latest commit in the build. - */ - commitTime?: string | null; - /** - * Output only. Path of the open source repository: github.com/apigee/registry. - */ - repo?: string | null; - } - /** - * The request message for Operations.CancelOperation. - */ - export interface Schema$CancelOperationRequest {} - /** - * Available configurations to provision an Instance. - */ - export interface Schema$Config { - /** - * Required. 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 InstanceConfig.location. - */ - cmekKeyName?: string | null; - /** - * Output only. The GCP location where the Instance resides. - */ - location?: 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 {} - /** - * 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; - } - /** - * 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; - } - /** - * An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project. - */ - export interface Schema$Instance { - /** - * Output only. Build info of the Instance if it's in `ACTIVE` state. - */ - build?: Schema$Build; - /** - * Required. Config of the Instance. - */ - config?: Schema$Config; - /** - * Output only. Creation timestamp. - */ - createTime?: string | null; - /** - * Format: `projects/x/locations/x/instance`. Currently only `locations/global` is supported. - */ - name?: string | null; - /** - * Output only. The current state of the Instance. - */ - state?: string | null; - /** - * Output only. Extra information of Instance.State if the state is `FAILED`. - */ - stateMessage?: string | null; - /** - * Output only. Last update timestamp. - */ - updateTime?: string | null; - } - /** - * Response message for ListApiDeploymentRevisionsResponse. - */ - export interface Schema$ListApiDeploymentRevisionsResponse { - /** - * The revisions of the deployment. - */ - apiDeployments?: Schema$ApiDeployment[]; - /** - * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - */ - nextPageToken?: string | null; - } - /** - * Response message for ListApiDeployments. - */ - export interface Schema$ListApiDeploymentsResponse { - /** - * The deployments from the specified publisher. - */ - apiDeployments?: Schema$ApiDeployment[]; - /** - * 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; - } - /** - * Response message for ListApiSpecRevisionsResponse. - */ - export interface Schema$ListApiSpecRevisionsResponse { - /** - * The revisions of the spec. - */ - apiSpecs?: Schema$ApiSpec[]; - /** - * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - */ - nextPageToken?: string | null; - } - /** - * Response message for ListApiSpecs. - */ - export interface Schema$ListApiSpecsResponse { - /** - * The specs from the specified publisher. - */ - apiSpecs?: Schema$ApiSpec[]; - /** - * 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; - } - /** - * Response message for ListApis. - */ - export interface Schema$ListApisResponse { - /** - * The APIs from the specified publisher. - */ - apis?: Schema$Api[]; - /** - * 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; - } - /** - * Response message for ListApiVersions. - */ - export interface Schema$ListApiVersionsResponse { - /** - * The versions from the specified publisher. - */ - apiVersions?: Schema$ApiVersion[]; - /** - * 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; - } - /** - * Response message for ListArtifacts. - */ - export interface Schema$ListArtifactsResponse { - /** - * The artifacts from the specified publisher. - */ - artifacts?: Schema$Artifact[]; - /** - * 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 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[]; - } - /** - * A resource that represents a Google Cloud location. - */ - export interface Schema$Location { - /** - * The friendly name for this location, typically a nearby city name. For example, "Tokyo". - */ - displayName?: string | null; - /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} - */ - labels?: {[key: string]: string} | null; - /** - * The canonical id for this location. For example: `"us-east1"`. - */ - locationId?: string | null; - /** - * Service-specific metadata. For example the available capacity at the given location. - */ - metadata?: {[key: string]: any} | null; - /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` - */ - name?: string | null; - } - /** - * This resource represents a long-running operation that is the result of a network API call. - */ - export interface Schema$Operation { - /** - * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - */ - done?: boolean | null; - /** - * The error result of the operation in case of failure or cancellation. - */ - error?: Schema$Status; - /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. - */ - metadata?: {[key: string]: any} | null; - /** - * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`. - */ - name?: string | null; - /** - * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. - */ - response?: {[key: string]: any} | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$OperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancellationRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * Human-readable status of the operation, if any. - */ - statusMessage?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: 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 { - /** - * 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; - } - /** - * Request message for RollbackApiDeployment. - */ - export interface Schema$RollbackApiDeploymentRequest { - /** - * Required. The revision ID to roll back to. It must be a revision of the same deployment. Example: `c7cfa2a8` - */ - revisionId?: string | null; - } - /** - * Request message for RollbackApiSpec. - */ - export interface Schema$RollbackApiSpecRequest { - /** - * Required. The revision ID to roll back to. It must be a revision of the same spec. Example: `c7cfa2a8` - */ - revisionId?: 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; - } - /** - * 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; - } - /** - * Request message for TagApiDeploymentRevision. - */ - export interface Schema$TagApiDeploymentRevisionRequest { - /** - * Required. The tag to apply. The tag should be at most 40 characters, and match `a-z{3,39\}`. - */ - tag?: string | null; - } - /** - * Request message for TagApiSpecRevision. - */ - export interface Schema$TagApiSpecRevisionRequest { - /** - * Required. The tag to apply. The tag should be at most 40 characters, and match `a-z{3,39\}`. - */ - tag?: 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; - 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; - apis: Resource$Projects$Locations$Apis; - artifacts: Resource$Projects$Locations$Artifacts; - documents: Resource$Projects$Locations$Documents; - instances: Resource$Projects$Locations$Instances; - operations: Resource$Projects$Locations$Operations; - runtime: Resource$Projects$Locations$Runtime; - constructor(context: APIRequestContext) { - this.context = context; - this.apis = new Resource$Projects$Locations$Apis(this.context); - this.artifacts = new Resource$Projects$Locations$Artifacts(this.context); - this.documents = new Resource$Projects$Locations$Documents(this.context); - this.instances = new Resource$Projects$Locations$Instances(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.runtime = new Resource$Projects$Locations$Runtime(this.context); - } - - /** - * Gets information about a location. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.get({ - * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "displayName": "my_displayName", - * // "labels": {}, - * // "locationId": "my_locationId", - * // "metadata": {}, - * // "name": "my_name" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.list({ - * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // The resource that owns the locations collection, if applicable. - * name: 'projects/my-project', - * // The maximum number of results to return. If not set, the service selects a default. - * pageSize: 'placeholder-value', - * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. - * pageToken: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "locations": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$List, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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 { - /** - * 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$Apis { - context: APIRequestContext; - artifacts: Resource$Projects$Locations$Apis$Artifacts; - deployments: Resource$Projects$Locations$Apis$Deployments; - versions: Resource$Projects$Locations$Apis$Versions; - constructor(context: APIRequestContext) { - this.context = context; - this.artifacts = new Resource$Projects$Locations$Apis$Artifacts( - this.context - ); - this.deployments = new Resource$Projects$Locations$Apis$Deployments( - this.context - ); - this.versions = new Resource$Projects$Locations$Apis$Versions( - this.context - ); - } - - /** - * Creates a specified API. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.create({ - * // Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - * apiId: 'placeholder-value', - * // Required. The parent, which owns this collection of APIs. Format: `projects/x/locations/x` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "availability": "my_availability", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "recommendedDeployment": "my_recommendedDeployment", - * // "recommendedVersion": "my_recommendedVersion", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "availability": "my_availability", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "recommendedDeployment": "my_recommendedDeployment", - * // "recommendedVersion": "my_recommendedVersion", - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Apis$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Apis$Create, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Removes a specified API and all of the resources that it owns. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.delete({ - * // If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.) - * force: 'placeholder-value', - * // Required. The name of the API to delete. Format: `projects/x/locations/x/apis/x` - * name: 'projects/my-project/locations/my-location/apis/my-api', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Apis$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Apis$Delete, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Returns a specified API. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.get({ - * // Required. The name of the API to retrieve. Format: `projects/x/locations/x/apis/x` - * name: 'projects/my-project/locations/my-location/apis/my-api', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "availability": "my_availability", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "recommendedDeployment": "my_recommendedDeployment", - * // "recommendedVersion": "my_recommendedVersion", - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Apis$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Apis$Get, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/apis/my-api', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Apis$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns matching APIs. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.list({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - * filter: 'placeholder-value', - * // A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - * orderBy: 'placeholder-value', - * // The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApis` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of APIs. Format: `projects/x/locations/x` - * parent: 'projects/my-project/locations/my-location', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "apis": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Apis$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Apis$List, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Used to modify a specified API. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.patch({ - * // If set to true, and the API is not found, a new API will be created. In this situation, `update_mask` is ignored. - * allowMissing: 'placeholder-value', - * // Resource name. - * name: 'projects/my-project/locations/my-location/apis/my-api', - * // The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "availability": "my_availability", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "recommendedDeployment": "my_recommendedDeployment", - * // "recommendedVersion": "my_recommendedVersion", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "availability": "my_availability", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "recommendedDeployment": "my_recommendedDeployment", - * // "recommendedVersion": "my_recommendedVersion", - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Apis$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Apis$Patch, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/apis/my-api', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Apis$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/apis/my-api', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Apis$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Apis$Create extends StandardParameters { - /** - * Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - */ - apiId?: string; - /** - * Required. The parent, which owns this collection of APIs. Format: `projects/x/locations/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Api; - } - export interface Params$Resource$Projects$Locations$Apis$Delete extends StandardParameters { - /** - * If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.) - */ - force?: boolean; - /** - * Required. The name of the API to delete. Format: `projects/x/locations/x/apis/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Get extends StandardParameters { - /** - * Required. The name of the API to retrieve. Format: `projects/x/locations/x/apis/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$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$Apis$List extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - */ - filter?: string; - /** - * A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - */ - orderBy?: string; - /** - * The maximum number of APIs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApis` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of APIs. Format: `projects/x/locations/x` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Patch extends StandardParameters { - /** - * If set to true, and the API is not found, a new API will be created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Resource name. - */ - name?: string; - /** - * The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Api; - } - export interface Params$Resource$Projects$Locations$Apis$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$Apis$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$Apis$Artifacts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.artifacts.create({ - * // Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - * artifactId: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: 'projects/my-project/locations/my-location/apis/my-api', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Apis$Artifacts$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Artifacts$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Artifacts$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Apis$Artifacts$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Removes a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.artifacts.delete({ - * // Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Apis$Artifacts$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Artifacts$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Artifacts$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Apis$Artifacts$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.artifacts.get({ - * // Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Apis$Artifacts$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Artifacts$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Artifacts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Apis$Artifacts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.artifacts.getContents({ - * // Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getContents( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Getcontents, - options: StreamMethodOptions - ): Promise>; - getContents( - params?: Params$Resource$Projects$Locations$Apis$Artifacts$Getcontents, - options?: MethodOptions - ): Promise>; - getContents( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Getcontents, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Getcontents, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Getcontents, - callback: BodyResponseCallback - ): void; - getContents(callback: BodyResponseCallback): void; - getContents( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Artifacts$Getcontents - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Artifacts$Getcontents; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Artifacts$Getcontents; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:getContents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.artifacts.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Artifacts$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Artifacts$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Artifacts$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Artifacts$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns matching artifacts. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.artifacts.list({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - * filter: 'placeholder-value', - * // A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - * orderBy: 'placeholder-value', - * // The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: 'projects/my-project/locations/my-location/apis/my-api', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "artifacts": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Apis$Artifacts$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Apis$Artifacts$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Apis$Artifacts$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Artifacts$List, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Artifacts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Artifacts$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Artifacts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Apis$Artifacts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Used to replace a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.artifacts.replaceArtifact({ - * // Resource name. - * name: 'projects/my-project/locations/my-location/apis/my-api/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Replaceartifact, - options: StreamMethodOptions - ): Promise>; - replaceArtifact( - params?: Params$Resource$Projects$Locations$Apis$Artifacts$Replaceartifact, - options?: MethodOptions - ): Promise>; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Replaceartifact, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Replaceartifact, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Replaceartifact, - callback: BodyResponseCallback - ): void; - replaceArtifact(callback: BodyResponseCallback): void; - replaceArtifact( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Artifacts$Replaceartifact - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Artifacts$Replaceartifact; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Artifacts$Replaceartifact; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.artifacts.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Artifacts$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Artifacts$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Artifacts$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Artifacts$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.artifacts.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Apis$Artifacts$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Artifacts$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Artifacts$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Artifacts$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Artifacts$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Apis$Artifacts$Create extends StandardParameters { - /** - * Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - */ - artifactId?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - export interface Params$Resource$Projects$Locations$Apis$Artifacts$Delete extends StandardParameters { - /** - * Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Artifacts$Get extends StandardParameters { - /** - * Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Artifacts$Getcontents extends StandardParameters { - /** - * Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Artifacts$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$Apis$Artifacts$List extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - */ - filter?: string; - /** - * A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - */ - orderBy?: string; - /** - * The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Artifacts$Replaceartifact extends StandardParameters { - /** - * Resource name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - export interface Params$Resource$Projects$Locations$Apis$Artifacts$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$Apis$Artifacts$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$Apis$Deployments { - context: APIRequestContext; - artifacts: Resource$Projects$Locations$Apis$Deployments$Artifacts; - constructor(context: APIRequestContext) { - this.context = context; - this.artifacts = - new Resource$Projects$Locations$Apis$Deployments$Artifacts( - this.context - ); - } - - /** - * Creates a specified deployment. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.deployments.create({ - * // Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - * apiDeploymentId: 'placeholder-value', - * // Required. The parent, which owns this collection of deployments. Format: `projects/x/locations/x/apis/x` - * parent: 'projects/my-project/locations/my-location/apis/my-api', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accessGuidance": "my_accessGuidance", - * // "annotations": {}, - * // "apiSpecRevision": "my_apiSpecRevision", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "endpointUri": "my_endpointUri", - * // "externalChannelUri": "my_externalChannelUri", - * // "intendedAudience": "my_intendedAudience", - * // "labels": {}, - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accessGuidance": "my_accessGuidance", - * // "annotations": {}, - * // "apiSpecRevision": "my_apiSpecRevision", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "endpointUri": "my_endpointUri", - * // "externalChannelUri": "my_externalChannelUri", - * // "intendedAudience": "my_intendedAudience", - * // "labels": {}, - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Apis$Deployments$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Apis$Deployments$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Deployments$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Deployments$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Removes a specified deployment, all revisions, and all child resources (e.g., artifacts). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.deployments.delete({ - * // If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.) - * force: 'placeholder-value', - * // Required. The name of the deployment to delete. Format: `projects/x/locations/x/apis/x/deployments/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Apis$Deployments$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Apis$Deployments$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Deployments$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Deployments$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Deletes a revision of a deployment. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.deleteRevision({ - * // Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8` - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accessGuidance": "my_accessGuidance", - * // "annotations": {}, - * // "apiSpecRevision": "my_apiSpecRevision", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "endpointUri": "my_endpointUri", - * // "externalChannelUri": "my_externalChannelUri", - * // "intendedAudience": "my_intendedAudience", - * // "labels": {}, - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - deleteRevision( - params: Params$Resource$Projects$Locations$Apis$Deployments$Deleterevision, - options: StreamMethodOptions - ): Promise>; - deleteRevision( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Deleterevision, - options?: MethodOptions - ): Promise>; - deleteRevision( - params: Params$Resource$Projects$Locations$Apis$Deployments$Deleterevision, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deleteRevision( - params: Params$Resource$Projects$Locations$Apis$Deployments$Deleterevision, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deleteRevision( - params: Params$Resource$Projects$Locations$Apis$Deployments$Deleterevision, - callback: BodyResponseCallback - ): void; - deleteRevision(callback: BodyResponseCallback): void; - deleteRevision( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Deleterevision - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Deleterevision; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Deleterevision; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:deleteRevision').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); - } - } - - /** - * Returns a specified deployment. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.deployments.get({ - * // Required. The name of the deployment to retrieve. Format: `projects/x/locations/x/apis/x/deployments/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accessGuidance": "my_accessGuidance", - * // "annotations": {}, - * // "apiSpecRevision": "my_apiSpecRevision", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "endpointUri": "my_endpointUri", - * // "externalChannelUri": "my_externalChannelUri", - * // "intendedAudience": "my_intendedAudience", - * // "labels": {}, - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Apis$Deployments$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Apis$Deployments$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Deployments$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Deployments$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Apis$Deployments$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Deployments$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Deployments$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Deployments$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Deployments$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns matching deployments. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.deployments.list({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - * filter: 'placeholder-value', - * // A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - * orderBy: 'placeholder-value', - * // The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListApiDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiDeployments` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of deployments. Format: `projects/x/locations/x/apis/x` - * parent: 'projects/my-project/locations/my-location/apis/my-api', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "apiDeployments": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Apis$Deployments$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Apis$Deployments$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Apis$Deployments$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Deployments$List, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Deployments$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Apis$Deployments$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.listRevisions({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - * filter: 'placeholder-value', - * // Required. The name of the deployment to list revisions for. - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * // The maximum number of revisions to return per page. - * pageSize: 'placeholder-value', - * // The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "apiDeployments": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - listRevisions( - params: Params$Resource$Projects$Locations$Apis$Deployments$Listrevisions, - options: StreamMethodOptions - ): Promise>; - listRevisions( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Listrevisions, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listRevisions( - params: Params$Resource$Projects$Locations$Apis$Deployments$Listrevisions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listRevisions( - params: Params$Resource$Projects$Locations$Apis$Deployments$Listrevisions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listRevisions( - params: Params$Resource$Projects$Locations$Apis$Deployments$Listrevisions, - callback: BodyResponseCallback - ): void; - listRevisions( - callback: BodyResponseCallback - ): void; - listRevisions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Listrevisions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Listrevisions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Listrevisions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:listRevisions').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 - ); - } - } - - /** - * Used to modify a specified deployment. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.deployments.patch({ - * // If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored. - * allowMissing: 'placeholder-value', - * // Resource name. - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * // The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accessGuidance": "my_accessGuidance", - * // "annotations": {}, - * // "apiSpecRevision": "my_apiSpecRevision", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "endpointUri": "my_endpointUri", - * // "externalChannelUri": "my_externalChannelUri", - * // "intendedAudience": "my_intendedAudience", - * // "labels": {}, - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accessGuidance": "my_accessGuidance", - * // "annotations": {}, - * // "apiSpecRevision": "my_apiSpecRevision", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "endpointUri": "my_endpointUri", - * // "externalChannelUri": "my_externalChannelUri", - * // "intendedAudience": "my_intendedAudience", - * // "labels": {}, - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Apis$Deployments$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Apis$Deployments$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Apis$Deployments$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Apis$Deployments$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.deployments.rollback( - * { - * // Required. The deployment being rolled back. - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "revisionId": "my_revisionId" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "accessGuidance": "my_accessGuidance", - * // "annotations": {}, - * // "apiSpecRevision": "my_apiSpecRevision", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "endpointUri": "my_endpointUri", - * // "externalChannelUri": "my_externalChannelUri", - * // "intendedAudience": "my_intendedAudience", - * // "labels": {}, - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - rollback( - params: Params$Resource$Projects$Locations$Apis$Deployments$Rollback, - options: StreamMethodOptions - ): Promise>; - rollback( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Rollback, - options?: MethodOptions - ): Promise>; - rollback( - params: Params$Resource$Projects$Locations$Apis$Deployments$Rollback, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - rollback( - params: Params$Resource$Projects$Locations$Apis$Deployments$Rollback, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - rollback( - params: Params$Resource$Projects$Locations$Apis$Deployments$Rollback, - callback: BodyResponseCallback - ): void; - rollback(callback: BodyResponseCallback): void; - rollback( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Rollback - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Rollback; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Rollback; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:rollback').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); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Deployments$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Deployments$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Deployments$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Deployments$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Adds a tag to a specified revision of a deployment. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.tagRevision({ - * // Required. The name of the deployment to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision. - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "tag": "my_tag" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accessGuidance": "my_accessGuidance", - * // "annotations": {}, - * // "apiSpecRevision": "my_apiSpecRevision", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "endpointUri": "my_endpointUri", - * // "externalChannelUri": "my_externalChannelUri", - * // "intendedAudience": "my_intendedAudience", - * // "labels": {}, - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - tagRevision( - params: Params$Resource$Projects$Locations$Apis$Deployments$Tagrevision, - options: StreamMethodOptions - ): Promise>; - tagRevision( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Tagrevision, - options?: MethodOptions - ): Promise>; - tagRevision( - params: Params$Resource$Projects$Locations$Apis$Deployments$Tagrevision, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - tagRevision( - params: Params$Resource$Projects$Locations$Apis$Deployments$Tagrevision, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - tagRevision( - params: Params$Resource$Projects$Locations$Apis$Deployments$Tagrevision, - callback: BodyResponseCallback - ): void; - tagRevision(callback: BodyResponseCallback): void; - tagRevision( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Tagrevision - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Tagrevision; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Tagrevision; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:tagRevision').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); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.testIamPermissions( - * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Deployments$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Deployments$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Deployments$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Deployments$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Apis$Deployments$Create extends StandardParameters { - /** - * Required. The ID to use for the deployment, which will become the final component of the deployment's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - */ - apiDeploymentId?: string; - /** - * Required. The parent, which owns this collection of deployments. Format: `projects/x/locations/x/apis/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ApiDeployment; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Delete extends StandardParameters { - /** - * If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.) - */ - force?: boolean; - /** - * Required. The name of the deployment to delete. Format: `projects/x/locations/x/apis/x/deployments/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Deleterevision extends StandardParameters { - /** - * Required. The name of the deployment revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/deployments/prod@c7cfa2a8` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Get extends StandardParameters { - /** - * Required. The name of the deployment to retrieve. Format: `projects/x/locations/x/apis/x/deployments/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$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$Apis$Deployments$List extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - */ - filter?: string; - /** - * A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - */ - orderBy?: string; - /** - * The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListApiDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiDeployments` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of deployments. Format: `projects/x/locations/x/apis/x` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Listrevisions extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - */ - filter?: string; - /** - * Required. The name of the deployment to list revisions for. - */ - name?: string; - /** - * The maximum number of revisions to return per page. - */ - pageSize?: number; - /** - * The page token, received from a previous ListApiDeploymentRevisions call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Patch extends StandardParameters { - /** - * If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Resource name. - */ - name?: string; - /** - * The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ApiDeployment; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Rollback extends StandardParameters { - /** - * Required. The deployment being rolled back. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RollbackApiDeploymentRequest; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$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$Apis$Deployments$Tagrevision extends StandardParameters { - /** - * Required. The name of the deployment to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TagApiDeploymentRevisionRequest; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$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$Apis$Deployments$Artifacts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.artifacts.create({ - * // Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - * artifactId: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: - * 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Removes a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.artifacts.delete({ - * // Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.artifacts.get({ - * // Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.artifacts.getContents( - * { - * // Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment/artifacts/my-artifact', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getContents( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Getcontents, - options: StreamMethodOptions - ): Promise>; - getContents( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Getcontents, - options?: MethodOptions - ): Promise>; - getContents( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Getcontents, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Getcontents, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Getcontents, - callback: BodyResponseCallback - ): void; - getContents(callback: BodyResponseCallback): void; - getContents( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Getcontents - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Getcontents; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Getcontents; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:getContents').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); - } - } - - /** - * Returns matching artifacts. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.artifacts.list({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - * filter: 'placeholder-value', - * // A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - * orderBy: 'placeholder-value', - * // The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: - * 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "artifacts": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$List, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Used to replace a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.deployments.artifacts.replaceArtifact( - * { - * // Resource name. - * name: 'projects/my-project/locations/my-location/apis/my-api/deployments/my-deployment/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Replaceartifact, - options: StreamMethodOptions - ): Promise>; - replaceArtifact( - params?: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Replaceartifact, - options?: MethodOptions - ): Promise>; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Replaceartifact, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Replaceartifact, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Replaceartifact, - callback: BodyResponseCallback - ): void; - replaceArtifact(callback: BodyResponseCallback): void; - replaceArtifact( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Replaceartifact - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Replaceartifact; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Replaceartifact; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Apis$Deployments$Artifacts$Create extends StandardParameters { - /** - * Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - */ - artifactId?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Delete extends StandardParameters { - /** - * Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Get extends StandardParameters { - /** - * Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Getcontents extends StandardParameters { - /** - * Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$List extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - */ - filter?: string; - /** - * A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - */ - orderBy?: string; - /** - * The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Deployments$Artifacts$Replaceartifact extends StandardParameters { - /** - * Resource name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - - export class Resource$Projects$Locations$Apis$Versions { - context: APIRequestContext; - artifacts: Resource$Projects$Locations$Apis$Versions$Artifacts; - specs: Resource$Projects$Locations$Apis$Versions$Specs; - constructor(context: APIRequestContext) { - this.context = context; - this.artifacts = new Resource$Projects$Locations$Apis$Versions$Artifacts( - this.context - ); - this.specs = new Resource$Projects$Locations$Apis$Versions$Specs( - this.context - ); - } - - /** - * Creates a specified version. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.versions.create({ - * // Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - * apiVersionId: 'placeholder-value', - * // Required. The parent, which owns this collection of versions. Format: `projects/x/locations/x/apis/x` - * parent: 'projects/my-project/locations/my-location/apis/my-api', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "primarySpec": "my_primarySpec", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "primarySpec": "my_primarySpec", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Apis$Versions$Create, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Removes a specified version and all of the resources that it owns. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.versions.delete({ - * // If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.) - * force: 'placeholder-value', - * // Required. The name of the version to delete. Format: `projects/x/locations/x/apis/x/versions/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Apis$Versions$Delete, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Returns a specified version. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.versions.get({ - * // Required. The name of the version to retrieve. Format: `projects/x/locations/x/apis/x/versions/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "primarySpec": "my_primarySpec", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Apis$Versions$Get, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Versions$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns matching versions. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.versions.list({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - * filter: 'placeholder-value', - * // A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - * orderBy: 'placeholder-value', - * // The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListApiVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiVersions` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of versions. Format: `projects/x/locations/x/apis/x` - * parent: 'projects/my-project/locations/my-location/apis/my-api', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "apiVersions": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Apis$Versions$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Apis$Versions$List, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Used to modify a specified version. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.versions.patch({ - * // If set to true, and the version is not found, a new version will be created. In this situation, `update_mask` is ignored. - * allowMissing: 'placeholder-value', - * // Resource name. - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * // The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "primarySpec": "my_primarySpec", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "labels": {}, - * // "name": "my_name", - * // "primarySpec": "my_primarySpec", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Apis$Versions$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Apis$Versions$Patch, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Versions$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Apis$Versions$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Apis$Versions$Create extends StandardParameters { - /** - * Required. The ID to use for the version, which will become the final component of the version's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - */ - apiVersionId?: string; - /** - * Required. The parent, which owns this collection of versions. Format: `projects/x/locations/x/apis/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ApiVersion; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Delete extends StandardParameters { - /** - * If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.) - */ - force?: boolean; - /** - * Required. The name of the version to delete. Format: `projects/x/locations/x/apis/x/versions/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Get extends StandardParameters { - /** - * Required. The name of the version to retrieve. Format: `projects/x/locations/x/apis/x/versions/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$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$Apis$Versions$List extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - */ - filter?: string; - /** - * A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - */ - orderBy?: string; - /** - * The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListApiVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiVersions` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of versions. Format: `projects/x/locations/x/apis/x` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Patch extends StandardParameters { - /** - * If set to true, and the version is not found, a new version will be created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Resource name. - */ - name?: string; - /** - * The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ApiVersion; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$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$Apis$Versions$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$Apis$Versions$Artifacts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.artifacts.create({ - * // Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - * artifactId: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Removes a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.artifacts.delete({ - * // Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.artifacts.get({ - * // Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.artifacts.getContents( - * { - * // Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/artifacts/my-artifact', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getContents( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getcontents, - options: StreamMethodOptions - ): Promise>; - getContents( - params?: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getcontents, - options?: MethodOptions - ): Promise>; - getContents( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getcontents, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getcontents, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getcontents, - callback: BodyResponseCallback - ): void; - getContents(callback: BodyResponseCallback): void; - getContents( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getcontents - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getcontents; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getcontents; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:getContents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.artifacts.getIamPolicy( - * { - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/artifacts/my-artifact', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns matching artifacts. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.artifacts.list({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - * filter: 'placeholder-value', - * // A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - * orderBy: 'placeholder-value', - * // The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "artifacts": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$List, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Artifacts$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Used to replace a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.artifacts.replaceArtifact( - * { - * // Resource name. - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Replaceartifact, - options: StreamMethodOptions - ): Promise>; - replaceArtifact( - params?: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Replaceartifact, - options?: MethodOptions - ): Promise>; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Replaceartifact, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Replaceartifact, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Replaceartifact, - callback: BodyResponseCallback - ): void; - replaceArtifact(callback: BodyResponseCallback): void; - replaceArtifact( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Replaceartifact - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Replaceartifact; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Replaceartifact; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.artifacts.setIamPolicy( - * { - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.artifacts.testIamPermissions( - * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Apis$Versions$Artifacts$Create extends StandardParameters { - /** - * Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - */ - artifactId?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Delete extends StandardParameters { - /** - * Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Get extends StandardParameters { - /** - * Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Getcontents extends StandardParameters { - /** - * Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Artifacts$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$Apis$Versions$Artifacts$List extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - */ - filter?: string; - /** - * A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - */ - orderBy?: string; - /** - * The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Artifacts$Replaceartifact extends StandardParameters { - /** - * Resource name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Artifacts$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$Apis$Versions$Artifacts$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$Apis$Versions$Specs { - context: APIRequestContext; - artifacts: Resource$Projects$Locations$Apis$Versions$Specs$Artifacts; - constructor(context: APIRequestContext) { - this.context = context; - this.artifacts = - new Resource$Projects$Locations$Apis$Versions$Specs$Artifacts( - this.context - ); - } - - /** - * Creates a specified spec. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.create({ - * // Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - * apiSpecId: 'placeholder-value', - * // Required. The parent, which owns this collection of specs. Format: `projects/x/locations/x/apis/x/versions/x` - * parent: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filename": "my_filename", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime", - * // "sizeBytes": 0, - * // "sourceUri": "my_sourceUri" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filename": "my_filename", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime", - * // "sizeBytes": 0, - * // "sourceUri": "my_sourceUri" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Create, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Removes a specified spec, all revisions, and all child resources (e.g., artifacts). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.delete({ - * // If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.) - * force: 'placeholder-value', - * // Required. The name of the spec to delete. Format: `projects/x/locations/x/apis/x/versions/x/specs/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Deletes a revision of a spec. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.deleteRevision({ - * // Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filename": "my_filename", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime", - * // "sizeBytes": 0, - * // "sourceUri": "my_sourceUri" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - deleteRevision( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Deleterevision, - options: StreamMethodOptions - ): Promise>; - deleteRevision( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Deleterevision, - options?: MethodOptions - ): Promise>; - deleteRevision( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Deleterevision, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deleteRevision( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Deleterevision, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deleteRevision( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Deleterevision, - callback: BodyResponseCallback - ): void; - deleteRevision(callback: BodyResponseCallback): void; - deleteRevision( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Deleterevision - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Deleterevision; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Deleterevision; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:deleteRevision').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); - } - } - - /** - * Returns a specified spec. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.versions.specs.get({ - * // Required. The name of the spec to retrieve. Format: `projects/x/locations/x/apis/x/versions/x/specs/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filename": "my_filename", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime", - * // "sizeBytes": 0, - * // "sourceUri": "my_sourceUri" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Get, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Returns the contents of a specified spec. If specs are stored with GZip compression, the default behavior is to return the spec uncompressed (the mime_type response field indicates the exact format returned). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.getContents({ - * // Required. The name of the spec whose contents should be retrieved. Format: `projects/x/locations/x/apis/x/versions/x/specs/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getContents( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents, - options: StreamMethodOptions - ): Promise>; - getContents( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:getContents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns matching specs. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.versions.specs.list({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - * filter: 'placeholder-value', - * // A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - * orderBy: 'placeholder-value', - * // The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListApiSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiSpecs` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of specs. Format: `projects/x/locations/x/apis/x/versions/x` - * parent: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "apiSpecs": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$List, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Lists all revisions of a spec. Revisions are returned in descending order of revision creation time. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.listRevisions({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - * filter: 'placeholder-value', - * // Required. The name of the spec to list revisions for. - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * // The maximum number of revisions to return per page. - * pageSize: 'placeholder-value', - * // The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "apiSpecs": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - listRevisions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Listrevisions, - options: StreamMethodOptions - ): Promise>; - listRevisions( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Listrevisions, - options?: MethodOptions - ): Promise>; - listRevisions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Listrevisions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listRevisions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Listrevisions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listRevisions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Listrevisions, - callback: BodyResponseCallback - ): void; - listRevisions( - callback: BodyResponseCallback - ): void; - listRevisions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Listrevisions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Listrevisions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Listrevisions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:listRevisions').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 - ); - } - } - - /** - * Used to modify a specified spec. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.apis.versions.specs.patch( - * { - * // If set to true, and the spec is not found, a new spec will be created. In this situation, `update_mask` is ignored. - * allowMissing: 'placeholder-value', - * // Resource name. - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * // The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filename": "my_filename", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime", - * // "sizeBytes": 0, - * // "sourceUri": "my_sourceUri" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filename": "my_filename", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime", - * // "sizeBytes": 0, - * // "sourceUri": "my_sourceUri" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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://apigeeregistry.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); - } - } - - /** - * Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.rollback({ - * // Required. The spec being rolled back. - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "revisionId": "my_revisionId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filename": "my_filename", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime", - * // "sizeBytes": 0, - * // "sourceUri": "my_sourceUri" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - rollback( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Rollback, - options: StreamMethodOptions - ): Promise>; - rollback( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Rollback, - options?: MethodOptions - ): Promise>; - rollback( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Rollback, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - rollback( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Rollback, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - rollback( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Rollback, - callback: BodyResponseCallback - ): void; - rollback(callback: BodyResponseCallback): void; - rollback( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Rollback - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Rollback; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Rollback; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:rollback').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); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Adds a tag to a specified revision of a spec. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.tagRevision({ - * // Required. The name of the spec to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision. - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "tag": "my_tag" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "filename": "my_filename", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "revisionCreateTime": "my_revisionCreateTime", - * // "revisionId": "my_revisionId", - * // "revisionUpdateTime": "my_revisionUpdateTime", - * // "sizeBytes": 0, - * // "sourceUri": "my_sourceUri" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - tagRevision( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Tagrevision, - options: StreamMethodOptions - ): Promise>; - tagRevision( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Tagrevision, - options?: MethodOptions - ): Promise>; - tagRevision( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Tagrevision, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - tagRevision( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Tagrevision, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - tagRevision( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Tagrevision, - callback: BodyResponseCallback - ): void; - tagRevision(callback: BodyResponseCallback): void; - tagRevision( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Tagrevision - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Tagrevision; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Tagrevision; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:tagRevision').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); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.testIamPermissions( - * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Apis$Versions$Specs$Create extends StandardParameters { - /** - * Required. The ID to use for the spec, which will become the final component of the spec's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - */ - apiSpecId?: string; - /** - * Required. The parent, which owns this collection of specs. Format: `projects/x/locations/x/apis/x/versions/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ApiSpec; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Delete extends StandardParameters { - /** - * If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.) - */ - force?: boolean; - /** - * Required. The name of the spec to delete. Format: `projects/x/locations/x/apis/x/versions/x/specs/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Deleterevision extends StandardParameters { - /** - * Required. The name of the spec revision to be deleted, with a revision ID explicitly included. Example: `projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi.yaml@c7cfa2a8` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Get extends StandardParameters { - /** - * Required. The name of the spec to retrieve. Format: `projects/x/locations/x/apis/x/versions/x/specs/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Getcontents extends StandardParameters { - /** - * Required. The name of the spec whose contents should be retrieved. Format: `projects/x/locations/x/apis/x/versions/x/specs/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$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$Apis$Versions$Specs$List extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - */ - filter?: string; - /** - * A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - */ - orderBy?: string; - /** - * The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListApiSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiSpecs` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of specs. Format: `projects/x/locations/x/apis/x/versions/x` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Listrevisions extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields. - */ - filter?: string; - /** - * Required. The name of the spec to list revisions for. - */ - name?: string; - /** - * The maximum number of revisions to return per page. - */ - pageSize?: number; - /** - * The page token, received from a previous ListApiSpecRevisions call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Patch extends StandardParameters { - /** - * If set to true, and the spec is not found, a new spec will be created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Resource name. - */ - name?: string; - /** - * The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ApiSpec; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Rollback extends StandardParameters { - /** - * Required. The spec being rolled back. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RollbackApiSpecRequest; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$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$Apis$Versions$Specs$Tagrevision extends StandardParameters { - /** - * Required. The name of the spec to be tagged, including the revision ID is optional. If a revision is not specified, it will tag the latest revision. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TagApiSpecRevisionRequest; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$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$Apis$Versions$Specs$Artifacts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.artifacts.create( - * { - * // Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - * artifactId: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Removes a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.artifacts.delete( - * { - * // Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec/artifacts/my-artifact', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.artifacts.get({ - * // Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.artifacts.getContents( - * { - * // Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec/artifacts/my-artifact', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getContents( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getcontents, - options: StreamMethodOptions - ): Promise>; - getContents( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getcontents, - options?: MethodOptions - ): Promise>; - getContents( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getcontents, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getcontents, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getcontents, - callback: BodyResponseCallback - ): void; - getContents(callback: BodyResponseCallback): void; - getContents( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getcontents - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getcontents; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getcontents; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:getContents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.artifacts.getIamPolicy( - * { - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec/artifacts/my-artifact', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns matching artifacts. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.artifacts.list({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - * filter: 'placeholder-value', - * // A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - * orderBy: 'placeholder-value', - * // The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "artifacts": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$List, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Used to replace a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.artifacts.replaceArtifact( - * { - * // Resource name. - * name: 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Replaceartifact, - options: StreamMethodOptions - ): Promise>; - replaceArtifact( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Replaceartifact, - options?: MethodOptions - ): Promise>; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Replaceartifact, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Replaceartifact, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Replaceartifact, - callback: BodyResponseCallback - ): void; - replaceArtifact(callback: BodyResponseCallback): void; - replaceArtifact( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Replaceartifact - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Replaceartifact; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Replaceartifact; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.artifacts.setIamPolicy( - * { - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.apis.versions.specs.artifacts.testIamPermissions( - * { - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/apis/my-api/versions/my-version/specs/my-spec/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Apis$Versions$Specs$Artifacts$Create extends StandardParameters { - /** - * Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - */ - artifactId?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Delete extends StandardParameters { - /** - * Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Get extends StandardParameters { - /** - * Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Getcontents extends StandardParameters { - /** - * Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$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$Apis$Versions$Specs$Artifacts$List extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - */ - filter?: string; - /** - * A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - */ - orderBy?: string; - /** - * The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$Replaceartifact extends StandardParameters { - /** - * Resource name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - export interface Params$Resource$Projects$Locations$Apis$Versions$Specs$Artifacts$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$Apis$Versions$Specs$Artifacts$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$Artifacts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.artifacts.create({ - * // Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - * artifactId: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Artifacts$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Artifacts$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Artifacts$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Artifacts$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Artifacts$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Artifacts$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Artifacts$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Artifacts$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Removes a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.artifacts.delete({ - * // Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Artifacts$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Artifacts$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Artifacts$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Artifacts$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Artifacts$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Artifacts$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Artifacts$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Artifacts$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.artifacts.get({ - * // Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Artifacts$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Artifacts$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Artifacts$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Artifacts$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Artifacts$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Artifacts$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Artifacts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Artifacts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns the contents of a specified artifact. If artifacts are stored with GZip compression, the default behavior is to return the artifact uncompressed (the mime_type response field indicates the exact format returned). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.artifacts.getContents({ - * // Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - * name: 'projects/my-project/locations/my-location/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getContents( - params: Params$Resource$Projects$Locations$Artifacts$Getcontents, - options: StreamMethodOptions - ): Promise>; - getContents( - params?: Params$Resource$Projects$Locations$Artifacts$Getcontents, - options?: MethodOptions - ): Promise>; - getContents( - params: Params$Resource$Projects$Locations$Artifacts$Getcontents, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Artifacts$Getcontents, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getContents( - params: Params$Resource$Projects$Locations$Artifacts$Getcontents, - callback: BodyResponseCallback - ): void; - getContents(callback: BodyResponseCallback): void; - getContents( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Artifacts$Getcontents - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Artifacts$Getcontents; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Artifacts$Getcontents; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:getContents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.artifacts.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Artifacts$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Artifacts$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Artifacts$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Artifacts$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Artifacts$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Artifacts$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Artifacts$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Artifacts$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Returns matching artifacts. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.artifacts.list({ - * // An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - * filter: 'placeholder-value', - * // A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - * orderBy: 'placeholder-value', - * // The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - * parent: 'projects/my-project/locations/my-location', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "artifacts": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Artifacts$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Artifacts$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Artifacts$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Artifacts$List, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Artifacts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Artifacts$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Artifacts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Artifacts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/artifacts').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); - } - } - - /** - * Used to replace a specified artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.artifacts.replaceArtifact( - * { - * // Resource name. - * name: 'projects/my-project/locations/my-location/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": {}, - * // "contents": "my_contents", - * // "createTime": "my_createTime", - * // "hash": "my_hash", - * // "labels": {}, - * // "mimeType": "my_mimeType", - * // "name": "my_name", - * // "sizeBytes": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - replaceArtifact( - params: Params$Resource$Projects$Locations$Artifacts$Replaceartifact, - options: StreamMethodOptions - ): Promise>; - replaceArtifact( - params?: Params$Resource$Projects$Locations$Artifacts$Replaceartifact, - options?: MethodOptions - ): Promise>; - replaceArtifact( - params: Params$Resource$Projects$Locations$Artifacts$Replaceartifact, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Artifacts$Replaceartifact, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceArtifact( - params: Params$Resource$Projects$Locations$Artifacts$Replaceartifact, - callback: BodyResponseCallback - ): void; - replaceArtifact(callback: BodyResponseCallback): void; - replaceArtifact( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Artifacts$Replaceartifact - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Artifacts$Replaceartifact; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Artifacts$Replaceartifact; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.artifacts.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Artifacts$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Artifacts$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Artifacts$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Artifacts$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Artifacts$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Artifacts$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Artifacts$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Artifacts$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.artifacts.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/artifacts/my-artifact', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Artifacts$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Artifacts$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Artifacts$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Artifacts$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Artifacts$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Artifacts$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Artifacts$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Artifacts$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Artifacts$Create extends StandardParameters { - /** - * Required. The ID to use for the artifact, which will become the final component of the artifact's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID. - */ - artifactId?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - export interface Params$Resource$Projects$Locations$Artifacts$Delete extends StandardParameters { - /** - * Required. The name of the artifact to delete. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Artifacts$Get extends StandardParameters { - /** - * Required. The name of the artifact to retrieve. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Artifacts$Getcontents extends StandardParameters { - /** - * Required. The name of the artifact whose contents should be retrieved. Format: `{parent\}/artifacts/x` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Artifacts$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$Artifacts$List extends StandardParameters { - /** - * An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields except contents. - */ - filter?: string; - /** - * A comma-separated list of fields, e.g. "foo,bar" Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar" - */ - orderBy?: string; - /** - * The maximum number of artifacts to return. The service may return fewer than this value. If unspecified, at most 50 values will be returned. The maximum is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListArtifacts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListArtifacts` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of artifacts. Format: `{parent\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Artifacts$Replaceartifact extends StandardParameters { - /** - * Resource name. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Artifact; - } - export interface Params$Resource$Projects$Locations$Artifacts$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$Artifacts$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$Documents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.documents.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/documents', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Documents$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Documents$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Documents$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Documents$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Documents$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Documents$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Documents$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Documents$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.documents.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/documents', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Documents$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Documents$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Documents$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Documents$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Documents$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Documents$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Documents$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Documents$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.documents.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/documents', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Documents$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Documents$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Documents$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Documents$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Documents$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Documents$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Documents$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Documents$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Documents$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$Documents$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$Documents$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$Instances { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Provisions instance resources for the Registry. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.instances.create({ - * // Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource. - * instanceId: 'placeholder-value', - * // Required. Parent resource of the Instance, of the form: `projects/x/locations/x` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "build": {}, - * // "config": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "state": "my_state", - * // "stateMessage": "my_stateMessage", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Instances$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Instances$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Instances$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Instances$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Instances$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Instances$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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 the Registry instance. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.instances.delete({ - * // Required. The name of the Instance to delete. Format: `projects/x/locations/x/instances/x`. - * name: 'projects/my-project/locations/my-location/instances/my-instance', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Instances$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Instances$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Instances$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Instances$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Instances$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Instances$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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 Instance. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.instances.get({ - * // Required. The name of the Instance to retrieve. Format: `projects/x/locations/x/instances/x`. - * name: 'projects/my-project/locations/my-location/instances/my-instance', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "build": {}, - * // "config": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "state": "my_state", - * // "stateMessage": "my_stateMessage", - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Instances$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Instances$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Instances$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Instances$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Instances$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Instances$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.instances.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/instances/my-instance', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Instances$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Instances$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.instances.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/instances/my-instance', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Instances$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Instances$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Instances$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.instances.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/instances/my-instance', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Instances$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Instances$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Instances$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Instances$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Instances$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Instances$Create extends StandardParameters { - /** - * Required. Identifier to assign to the Instance. Must be unique within scope of the parent resource. - */ - instanceId?: string; - /** - * Required. Parent resource of the Instance, of the form: `projects/x/locations/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Instance; - } - export interface Params$Resource$Projects$Locations$Instances$Delete extends StandardParameters { - /** - * Required. The name of the Instance to delete. Format: `projects/x/locations/x/instances/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Instances$Get extends StandardParameters { - /** - * Required. The name of the Instance to retrieve. Format: `projects/x/locations/x/instances/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Instances$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$Instances$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$Instances$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; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: StreamMethodOptions - ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, - options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Operations$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Operations$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Operations$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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; - } - - export class Resource$Projects$Locations$Runtime { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.runtime.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/runtime', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Runtime$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Runtime$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Runtime$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Runtime$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Runtime$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Runtime$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Runtime$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Runtime$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await apigeeregistry.projects.locations.runtime.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/runtime', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Runtime$Setiampolicy, - options: StreamMethodOptions - ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Runtime$Setiampolicy, - options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Runtime$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Runtime$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Runtime$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Runtime$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Runtime$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Runtime$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/apigeeregistry.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const apigeeregistry = google.apigeeregistry('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await apigeeregistry.projects.locations.runtime.testIamPermissions({ - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/runtime', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "permissions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Runtime$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Runtime$Testiampermissions, - options?: MethodOptions - ): Promise>; - testIamPermissions( - params: Params$Resource$Projects$Locations$Runtime$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Runtime$Testiampermissions, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Runtime$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Runtime$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Runtime$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Runtime$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://apigeeregistry.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$Runtime$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$Runtime$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$Runtime$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/apihub/v1.ts b/src/apis/apihub/v1.ts index 365cd7f0628..bfdf0758352 100644 --- a/src/apis/apihub/v1.ts +++ b/src/apis/apihub/v1.ts @@ -256,11 +256,11 @@ export namespace apihub_v1 { */ export interface Schema$GoogleCloudApihubV1Api { /** - * Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. + * Optional. The api functional requirements associated with the API resource. Cardinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. */ apiFunctionalRequirements?: Schema$GoogleCloudApihubV1AttributeValues; /** - * Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. + * Optional. The api requirement doc associated with the API resource. Cardinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. */ apiRequirements?: Schema$GoogleCloudApihubV1AttributeValues; /** @@ -268,7 +268,7 @@ export namespace apihub_v1 { */ apiStyle?: Schema$GoogleCloudApihubV1AttributeValues; /** - * Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. + * Optional. The api technical requirements associated with the API resource. Cardinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project\}/locations/{location\}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. */ apiTechnicalRequirements?: Schema$GoogleCloudApihubV1AttributeValues; /** diff --git a/src/apis/apikeys/v2.ts b/src/apis/apikeys/v2.ts index 4c0e394dd21..1c07cda2e55 100644 --- a/src/apis/apikeys/v2.ts +++ b/src/apis/apikeys/v2.ts @@ -375,6 +375,8 @@ export namespace apikeys_v2 { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ + * 'https://www.googleapis.com/auth/apikeys', + * 'https://www.googleapis.com/auth/apikeys.readonly', * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/cloud-platform.read-only', * ], @@ -526,6 +528,8 @@ export namespace apikeys_v2 { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ + * 'https://www.googleapis.com/auth/apikeys', + * 'https://www.googleapis.com/auth/apikeys.readonly', * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/cloud-platform.read-only', * ], @@ -696,7 +700,10 @@ export namespace apikeys_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/apikeys', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -853,7 +860,10 @@ export namespace apikeys_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/apikeys', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -995,6 +1005,8 @@ export namespace apikeys_v2 { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ + * 'https://www.googleapis.com/auth/apikeys', + * 'https://www.googleapis.com/auth/apikeys.readonly', * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/cloud-platform.read-only', * ], @@ -1141,6 +1153,8 @@ export namespace apikeys_v2 { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ + * 'https://www.googleapis.com/auth/apikeys', + * 'https://www.googleapis.com/auth/apikeys.readonly', * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/cloud-platform.read-only', * ], @@ -1284,6 +1298,8 @@ export namespace apikeys_v2 { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ + * 'https://www.googleapis.com/auth/apikeys', + * 'https://www.googleapis.com/auth/apikeys.readonly', * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/cloud-platform.read-only', * ], @@ -1427,7 +1443,10 @@ export namespace apikeys_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/apikeys', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -1586,7 +1605,10 @@ export namespace apikeys_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/apikeys', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], * }); * * // Acquire an auth client, and bind it to all future calls diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index 0e7441d5cdc..3680d923b10 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -1755,6 +1755,10 @@ export namespace backupdr_v1 { * Optional. A list of features to enable in the guest operating system. This is applicable only for bootable images. */ guestOsFeature?: Schema$GuestOsFeature[]; + /** + * Provides options for creating a disk from a source Compute Instance backup. + */ + instanceBackupSource?: Schema$RestoreDiskFromInstanceOptions; /** * Optional. Labels to apply to this disk. These can be modified later using setLabels method. Label values can be empty. */ @@ -2885,6 +2889,19 @@ export namespace backupdr_v1 { */ targetResource?: Schema$TargetResource; } + /** + * Options for creating a disk from a source Compute Instance backup. + */ + export interface Schema$RestoreDiskFromInstanceOptions { + /** + * Specifies that the boot disk should be restored from the instance backup. This field should only be set to `true` if selected. + */ + bootDisk?: boolean | null; + /** + * The device name of the disk to restore from the VM backup. + */ + sourceDeviceName?: string | null; + } /** * Message for rules config info. */ diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 8ecf0030f1e..dd142e767e1 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -1905,7 +1905,7 @@ export namespace bigquery_v2 { */ errorStats?: Schema$GenAiErrorStats; /** - * Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview + * Function level stats for GenAI Functions. For more information, see [Generative AI overview](https://docs.cloud.google.com/bigquery/docs/generative-ai-overview). */ functionStats?: Schema$GenAiFunctionStats[]; } diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 3f8ef6cd98e..b9b4ba0d024 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -226,7 +226,7 @@ export namespace chat_v1 { userFacingMessage?: string | null; } /** - * Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user\}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" \}, "type":"MENTION" \} \}] ``` + * Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user\}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" \}, "type":"MENTION" \} \}] ``` */ export interface Schema$Annotation { /** diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 94b71095b32..ac11f4483e8 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -6761,7 +6761,7 @@ export namespace classroom_v1 { * courseId: 'placeholder-value', * // Identifier of the course work. * id: 'placeholder-value', - * // Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` + * // Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` * `learning_goals` * updateMask: 'placeholder-value', * * // Request body metadata @@ -7183,7 +7183,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` + * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` * `learning_goals` */ updateMask?: string; @@ -11495,7 +11495,7 @@ export namespace classroom_v1 { * courseId: 'placeholder-value', * // Identifier of the course work material. * id: 'placeholder-value', - * // Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id` + * // Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id` * `learning_goals` * updateMask: 'placeholder-value', * * // Request body metadata @@ -11728,7 +11728,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id` + * Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id` * `learning_goals` */ updateMask?: string; diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 9e81ee5a45c..53c1223ebc1 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -277,41 +277,6 @@ export namespace cloudbuild_v1 { */ createTime?: string | null; } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method. - */ - export interface Schema$BatchCreateGitLabConnectedRepositoriesRequest { - /** - * Required. Requests to connect GitLab repositories. - */ - requests?: Schema$CreateGitLabConnectedRepositoryRequest[]; - } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Response of BatchCreateGitLabConnectedRepositories RPC method. - */ - export interface Schema$BatchCreateGitLabConnectedRepositoriesResponse { - /** - * The GitLab connected repository requests' responses. - */ - gitlabConnectedRepositories?: Schema$GitLabConnectedRepository[]; - } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `BatchCreateGitLabConnectedRepositories` operation. - */ - export interface Schema$BatchCreateGitLabConnectedRepositoriesResponseMetadata { - /** - * Time the operation was completed. - */ - completeTime?: string | null; - /** - * The name of the `GitLabConfig` that added connected repositories. Format: `projects/{project\}/locations/{location\}/gitLabConfigs/{config\}` - */ - config?: string | null; - /** - * Time the operation was created. - */ - createTime?: string | null; - } /** * BitbucketServerConfig represents the configuration for a Bitbucket Server. */ @@ -840,10 +805,6 @@ export namespace cloudbuild_v1 { * GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`. */ github?: Schema$GitHubEventsConfig; - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - */ - gitlabEnterpriseEventsConfig?: Schema$GitLabEventsConfig; /** * Output only. Unique identifier of the trigger. */ @@ -1011,36 +972,6 @@ export namespace cloudbuild_v1 { */ githubEnterpriseConfig?: string | null; } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `CreateGitLabConfig` operation. - */ - export interface Schema$CreateGitLabConfigOperationMetadata { - /** - * Time the operation was completed. - */ - completeTime?: string | null; - /** - * Time the operation was created. - */ - createTime?: string | null; - /** - * The resource name of the GitLabConfig to be created. Format: `projects/{project\}/locations/{location\}/gitlabConfigs/{id\}`. - */ - gitlabConfig?: string | null; - } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Request to connect a repository from a connected GitLab host. - */ - export interface Schema$CreateGitLabConnectedRepositoryRequest { - /** - * Required. The GitLab repository to connect. - */ - gitlabConnectedRepository?: Schema$GitLabConnectedRepository; - /** - * Required. The name of the `GitLabConfig` that adds connected repository. Format: `projects/{project\}/locations/{location\}/gitLabConfigs/{config\}` - */ - parent?: string | null; - } /** * Metadata for the `CreateWorkerPool` operation. */ @@ -1105,23 +1036,6 @@ export namespace cloudbuild_v1 { */ githubEnterpriseConfig?: string | null; } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `DeleteGitLabConfig` operation. - */ - export interface Schema$DeleteGitLabConfigOperationMetadata { - /** - * Time the operation was completed. - */ - completeTime?: string | null; - /** - * Time the operation was created. - */ - createTime?: string | null; - /** - * The resource name of the GitLabConfig to be created. Format: `projects/{project\}/locations/{location\}/gitlabConfigs/{id\}`. - */ - gitlabConfig?: string | null; - } /** * Metadata for the `DeleteWorkerPool` operation. */ @@ -1395,157 +1309,6 @@ export namespace cloudbuild_v1 { */ push?: Schema$PushFilter; } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. - */ - export interface Schema$GitLabConfig { - /** - * Connected GitLab.com or GitLabEnterprise repositories for this config. - */ - connectedRepositories?: Schema$GitLabRepositoryId[]; - /** - * Output only. Time when the config was created. - */ - createTime?: string | null; - /** - * Optional. GitLabEnterprise config. - */ - enterpriseConfig?: Schema$GitLabEnterpriseConfig; - /** - * Identifier. The resource name for the config. - */ - name?: string | null; - /** - * Required. Secret Manager secrets needed by the config. - */ - secrets?: Schema$GitLabSecrets; - /** - * Username of the GitLab.com or GitLab Enterprise account Cloud Build will use. - */ - username?: string | null; - /** - * Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config. - */ - webhookKey?: string | null; - } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConnectedRepository represents a GitLab connected repository request response. - */ - export interface Schema$GitLabConnectedRepository { - /** - * The name of the `GitLabConfig` that added connected repository. Format: `projects/{project\}/locations/{location\}/gitLabConfigs/{config\}` - */ - parent?: string | null; - /** - * The GitLab repositories to connect. - */ - repo?: Schema$GitLabRepositoryId; - /** - * Output only. The status of the repo connection request. - */ - status?: Schema$Status; - } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. - */ - export interface Schema$GitLabEnterpriseConfig { - /** - * Immutable. The URI of the GitlabEnterprise host. - */ - hostUri?: string | null; - /** - * The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. - */ - serviceDirectoryConfig?: Schema$ServiceDirectoryConfig; - /** - * The SSL certificate to use in requests to GitLab Enterprise instances. - */ - sslCa?: string | null; - } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. - */ - export interface Schema$GitLabEventsConfig { - /** - * Output only. The GitLabConfig specified in the gitlab_config_resource field. - */ - gitlabConfig?: Schema$GitLabConfig; - /** - * The GitLab config resource that this trigger config maps to. - */ - gitlabConfigResource?: string | null; - /** - * Namespace of the GitLab project. - */ - projectNamespace?: string | null; - /** - * Filter to match changes in pull requests. - */ - pullRequest?: Schema$PullRequestFilter; - /** - * Filter to match changes in refs like branches, tags. - */ - push?: Schema$PushFilter; - } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Proto Representing a GitLabRepository - */ - export interface Schema$GitLabRepository { - /** - * Link to the browse repo page on the GitLab instance - */ - browseUri?: string | null; - /** - * Description of the repository - */ - description?: string | null; - /** - * Display name of the repository - */ - displayName?: string | null; - /** - * The resource name of the repository - */ - name?: string | null; - /** - * Identifier for a repository - */ - repositoryId?: Schema$GitLabRepositoryId; - } - /** - * GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise - */ - export interface Schema$GitLabRepositoryId { - /** - * Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID - */ - id?: string | null; - /** - * Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo. - */ - webhookId?: number | null; - } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. - */ - export interface Schema$GitLabSecrets { - /** - * Required. The resource name for the api access token’s secret version - */ - apiAccessTokenVersion?: string | null; - /** - * Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. - */ - apiKeyVersion?: string | null; - /** - * Required. The resource name for the read access token’s secret version - */ - readAccessTokenVersion?: string | null; - /** - * Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig. - */ - webhookSecretVersion?: string | null; - } /** * GitRepoSource describes a repo and ref of a code repository. */ @@ -1604,6 +1367,10 @@ export namespace cloudbuild_v1 { * Required. Where should the files be placed on the worker. */ destPath?: string | null; + /** + * Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags. + */ + fetchTags?: boolean | null; /** * Optional. True if submodules should be fetched too (default false). */ @@ -1772,32 +1539,6 @@ export namespace cloudbuild_v1 { */ configs?: Schema$GitHubEnterpriseConfig[]; } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC response object returned by ListGitLabConfigs RPC method. - */ - export interface Schema$ListGitLabConfigsResponse { - /** - * A list of GitLabConfigs - */ - gitlabConfigs?: Schema$GitLabConfig[]; - /** - * A token that can be sent as `page_token` to retrieve the next page If this field is omitted, there are no subsequent pages. - */ - nextPageToken?: string | null; - } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC response object returned by the ListGitLabRepositories RPC method. - */ - export interface Schema$ListGitLabRepositoriesResponse { - /** - * List of GitLab repositories - */ - gitlabRepositories?: Schema$GitLabRepository[]; - /** - * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - */ - nextPageToken?: string | null; - } /** * Response containing existing `WorkerPools`. */ @@ -2086,15 +1827,6 @@ export namespace cloudbuild_v1 { */ connectedRepository?: Schema$BitbucketServerRepositoryId; } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC request object accepted by RemoveGitLabConnectedRepository RPC method. - */ - export interface Schema$RemoveGitLabConnectedRepositoryRequest { - /** - * The connected repository to remove. - */ - connectedRepository?: Schema$GitLabRepositoryId; - } /** * The configuration of a trigger that creates a build whenever an event from Repo API is received. */ @@ -2279,15 +2011,6 @@ export namespace cloudbuild_v1 { */ secretManager?: Schema$SecretManagerSecret[]; } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. - */ - export interface Schema$ServiceDirectoryConfig { - /** - * The Service Directory service name. Format: projects/{project\}/locations/{location\}/namespaces/{namespace\}/services/{service\}. - */ - service?: string | null; - } /** * Location of the source in a supported storage service. */ @@ -2465,23 +2188,6 @@ export namespace cloudbuild_v1 { */ githubEnterpriseConfig?: string | null; } - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `UpdateGitLabConfig` operation. - */ - export interface Schema$UpdateGitLabConfigOperationMetadata { - /** - * Time the operation was completed. - */ - completeTime?: string | null; - /** - * Time the operation was created. - */ - createTime?: string | null; - /** - * The resource name of the GitLabConfig to be created. Format: `projects/{project\}/locations/{location\}/gitlabConfigs/{id\}`. - */ - gitlabConfig?: string | null; - } /** * Metadata for the `UpdateWorkerPool` operation. */ @@ -3511,7 +3217,7 @@ export namespace cloudbuild_v1 { } /** - * Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds/{id\}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}:cancel`. + * Cancels a build in progress. Note: This method only cancels builds in the "global" region when using the legacy resource path projects/{project_id\}/builds/{id\}:cancel. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}:cancel`. * @example * ```js * // Before running the sample: @@ -3688,7 +3394,7 @@ export namespace cloudbuild_v1 { } /** - * Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds`. To create regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds`. + * Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates builds in the "global" region when using the legacy resource path projects/{project_id\}/builds. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds`. * @example * ```js * // Before running the sample: @@ -3868,7 +3574,7 @@ export namespace cloudbuild_v1 { } /** - * Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds/{id\}`. To fetch regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}`. + * Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only gets builds in the "global" region when using the legacy resource path projects/{project_id\}/builds/{id\}. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}`. * @example * ```js * // Before running the sample: @@ -4038,7 +3744,7 @@ export namespace cloudbuild_v1 { } /** - * Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds`. To list regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds`. + * Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists builds in the "global" region when using the legacy resource path projects/{project_id\}/builds. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds`. * @example * ```js * // Before running the sample: @@ -4184,7 +3890,7 @@ export namespace cloudbuild_v1 { } /** - * Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds/{id\}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings. + * Creates a new build based on the specified build. Note: This method only creates builds in the "global" region when using the legacy resource path projects/{project_id\}/builds/{id\}:retry. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings. * @example * ```js * // Before running the sample: @@ -5265,7 +4971,6 @@ export namespace cloudbuild_v1 { bitbucketServerConfigs: Resource$Projects$Locations$Bitbucketserverconfigs; builds: Resource$Projects$Locations$Builds; githubEnterpriseConfigs: Resource$Projects$Locations$Githubenterpriseconfigs; - gitLabConfigs: Resource$Projects$Locations$Gitlabconfigs; operations: Resource$Projects$Locations$Operations; triggers: Resource$Projects$Locations$Triggers; workerPools: Resource$Projects$Locations$Workerpools; @@ -5276,9 +4981,6 @@ export namespace cloudbuild_v1 { this.builds = new Resource$Projects$Locations$Builds(this.context); this.githubEnterpriseConfigs = new Resource$Projects$Locations$Githubenterpriseconfigs(this.context); - this.gitLabConfigs = new Resource$Projects$Locations$Gitlabconfigs( - this.context - ); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -6930,7 +6632,7 @@ export namespace cloudbuild_v1 { } /** - * Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds/{id\}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}:cancel`. + * Cancels a build in progress. Note: This method only cancels builds in the "global" region when using the legacy resource path projects/{project_id\}/builds/{id\}:cancel. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}:cancel`. * @example * ```js * // Before running the sample: @@ -7103,7 +6805,7 @@ export namespace cloudbuild_v1 { } /** - * Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds`. To create regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds`. + * Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates builds in the "global" region when using the legacy resource path projects/{project_id\}/builds. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds`. * @example * ```js * // Before running the sample: @@ -7283,7 +6985,7 @@ export namespace cloudbuild_v1 { } /** - * Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds/{id\}`. To fetch regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}`. + * Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only gets builds in the "global" region when using the legacy resource path projects/{project_id\}/builds/{id\}. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}`. * @example * ```js * // Before running the sample: @@ -7450,7 +7152,7 @@ export namespace cloudbuild_v1 { } /** - * Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds`. To list regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds`. + * Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists builds in the "global" region when using the legacy resource path projects/{project_id\}/builds. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds`. * @example * ```js * // Before running the sample: @@ -7596,7 +7298,7 @@ export namespace cloudbuild_v1 { } /** - * Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id\}/builds/{id\}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings. + * Creates a new build based on the specified build. Note: This method only creates builds in the "global" region when using the legacy resource path projects/{project_id\}/builds/{id\}:retry. For all regions, use the regional resource path: `projects/{project_id\}/locations/{location\}/builds/{id\}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings. * @example * ```js * // Before running the sample: @@ -8669,1312 +8371,6 @@ export namespace cloudbuild_v1 { requestBody?: Schema$GitHubEnterpriseConfig; } - export class Resource$Projects$Locations$Gitlabconfigs { - context: APIRequestContext; - connectedRepositories: Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories; - repos: Resource$Projects$Locations$Gitlabconfigs$Repos; - constructor(context: APIRequestContext) { - this.context = context; - this.connectedRepositories = - new Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories( - this.context - ); - this.repos = new Resource$Projects$Locations$Gitlabconfigs$Repos( - this.context - ); - } - - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Creates a new `GitLabConfig`. This API is experimental - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudbuild = google.cloudbuild('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await cloudbuild.projects.locations.gitLabConfigs.create({ - * // Optional. The ID to use for the GitLabConfig, which will become the final component of the GitLabConfig’s resource name. gitlab_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character - * gitlabConfigId: 'placeholder-value', - * // Required. Name of the parent resource. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "connectedRepositories": [], - * // "createTime": "my_createTime", - * // "enterpriseConfig": {}, - * // "name": "my_name", - * // "secrets": {}, - * // "username": "my_username", - * // "webhookKey": "my_webhookKey" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Gitlabconfigs$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gitlabconfigs$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gitlabconfigs$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gitlabconfigs$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/gitLabConfigs').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); - } - } - - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Delete a `GitLabConfig`. This API is experimental - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudbuild = google.cloudbuild('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await cloudbuild.projects.locations.gitLabConfigs.delete({ - * // Required. The config resource name. - * name: 'projects/my-project/locations/my-location/gitLabConfigs/my-gitLabConfig', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Gitlabconfigs$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gitlabconfigs$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gitlabconfigs$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gitlabconfigs$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbuild.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); - } - } - - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Retrieves a `GitLabConfig`. This API is experimental - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudbuild = google.cloudbuild('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await cloudbuild.projects.locations.gitLabConfigs.get({ - * // Required. The config resource name. - * name: 'projects/my-project/locations/my-location/gitLabConfigs/my-gitLabConfig', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "connectedRepositories": [], - * // "createTime": "my_createTime", - * // "enterpriseConfig": {}, - * // "name": "my_name", - * // "secrets": {}, - * // "username": "my_username", - * // "webhookKey": "my_webhookKey" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Gitlabconfigs$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gitlabconfigs$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gitlabconfigs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gitlabconfigs$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbuild.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); - } - } - - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. List all `GitLabConfigs` for a given project. This API is experimental - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudbuild = google.cloudbuild('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await cloudbuild.projects.locations.gitLabConfigs.list({ - * // The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 50 configs will be returned. The maximum value is 1000;, values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous ‘ListGitlabConfigsRequest’ call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ‘ListGitlabConfigsRequest’ must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. Name of the parent resource - * parent: 'projects/my-project/locations/my-location', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "gitlabConfigs": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Gitlabconfigs$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Gitlabconfigs$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Gitlabconfigs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gitlabconfigs$List, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gitlabconfigs$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gitlabconfigs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gitlabconfigs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gitlabconfigs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/gitLabConfigs').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); - } - } - - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Updates an existing `GitLabConfig`. This API is experimental - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudbuild = google.cloudbuild('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await cloudbuild.projects.locations.gitLabConfigs.patch({ - * // Identifier. The resource name for the config. - * name: 'projects/my-project/locations/my-location/gitLabConfigs/my-gitLabConfig', - * // Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "connectedRepositories": [], - * // "createTime": "my_createTime", - * // "enterpriseConfig": {}, - * // "name": "my_name", - * // "secrets": {}, - * // "username": "my_username", - * // "webhookKey": "my_webhookKey" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Gitlabconfigs$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gitlabconfigs$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gitlabconfigs$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gitlabconfigs$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbuild.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); - } - } - - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudbuild = google.cloudbuild('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await cloudbuild.projects.locations.gitLabConfigs.removeGitLabConnectedRepository( - * { - * // Required. The name of the `GitLabConfig` to remove a connected repository. Format: `projects/{project\}/locations/{location\}/gitLabConfigs/{config\}` - * config: - * 'projects/my-project/locations/my-location/gitLabConfigs/my-gitLabConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "connectedRepository": {} - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - removeGitLabConnectedRepository( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Removegitlabconnectedrepository, - options: StreamMethodOptions - ): Promise>; - removeGitLabConnectedRepository( - params?: Params$Resource$Projects$Locations$Gitlabconfigs$Removegitlabconnectedrepository, - options?: MethodOptions - ): Promise>; - removeGitLabConnectedRepository( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Removegitlabconnectedrepository, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeGitLabConnectedRepository( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Removegitlabconnectedrepository, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - removeGitLabConnectedRepository( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Removegitlabconnectedrepository, - callback: BodyResponseCallback - ): void; - removeGitLabConnectedRepository( - callback: BodyResponseCallback - ): void; - removeGitLabConnectedRepository( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gitlabconfigs$Removegitlabconnectedrepository - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gitlabconfigs$Removegitlabconnectedrepository; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Gitlabconfigs$Removegitlabconnectedrepository; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1/{+config}:removeGitLabConnectedRepository' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['config'], - pathParams: ['config'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Gitlabconfigs$Create extends StandardParameters { - /** - * Optional. The ID to use for the GitLabConfig, which will become the final component of the GitLabConfig’s resource name. gitlab_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character - */ - gitlabConfigId?: string; - /** - * Required. Name of the parent resource. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GitLabConfig; - } - export interface Params$Resource$Projects$Locations$Gitlabconfigs$Delete extends StandardParameters { - /** - * Required. The config resource name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gitlabconfigs$Get extends StandardParameters { - /** - * Required. The config resource name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gitlabconfigs$List extends StandardParameters { - /** - * The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 50 configs will be returned. The maximum value is 1000;, values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous ‘ListGitlabConfigsRequest’ call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ‘ListGitlabConfigsRequest’ must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. Name of the parent resource - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Gitlabconfigs$Patch extends StandardParameters { - /** - * Identifier. The resource name for the config. - */ - name?: string; - /** - * Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GitLabConfig; - } - export interface Params$Resource$Projects$Locations$Gitlabconfigs$Removegitlabconnectedrepository extends StandardParameters { - /** - * Required. The name of the `GitLabConfig` to remove a connected repository. Format: `projects/{project\}/locations/{location\}/gitLabConfigs/{config\}` - */ - config?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemoveGitLabConnectedRepositoryRequest; - } - - export class Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. Batch connecting GitLab repositories to Cloud Build. This API is experimental. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudbuild = google.cloudbuild('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await cloudbuild.projects.locations.gitLabConfigs.connectedRepositories.batchCreate( - * { - * // The name of the `GitLabConfig` that adds connected repositories. Format: `projects/{project\}/locations/{location\}/gitLabConfigs/{config\}` - * parent: - * 'projects/my-project/locations/my-location/gitLabConfigs/my-gitLabConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - batchCreate( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories$Batchcreate, - options: StreamMethodOptions - ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories$Batchcreate, - options?: MethodOptions - ): Promise>; - batchCreate( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories$Batchcreate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories$Batchcreate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories$Batchcreate, - callback: BodyResponseCallback - ): void; - batchCreate(callback: BodyResponseCallback): void; - batchCreate( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories$Batchcreate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories$Batchcreate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Gitlabconfigs$Connectedrepositories$Batchcreate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1/{+parent}/connectedRepositories:batchCreate' - ).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$Gitlabconfigs$Connectedrepositories$Batchcreate extends StandardParameters { - /** - * The name of the `GitLabConfig` that adds connected repositories. Format: `projects/{project\}/locations/{location\}/gitLabConfigs/{config\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BatchCreateGitLabConnectedRepositoriesRequest; - } - - export class Resource$Projects$Locations$Gitlabconfigs$Repos { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deprecated: CloudBuild GitLab V1 integration is deprecated. List all repositories for a given `GitLabConfig`. This API is experimental - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/cloudbuild.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const cloudbuild = google.cloudbuild('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await cloudbuild.projects.locations.gitLabConfigs.repos.list({ - * // The maximum number of repositories to return. The service may return fewer than this value. - * pageSize: 'placeholder-value', - * // A page token, received from a previous ListGitLabRepositoriesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGitLabRepositoriesRequest` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. Name of the parent resource. - * parent: - * 'projects/my-project/locations/my-location/gitLabConfigs/my-gitLabConfig', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "gitlabRepositories": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Repos$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Gitlabconfigs$Repos$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Repos$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Repos$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gitlabconfigs$Repos$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gitlabconfigs$Repos$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gitlabconfigs$Repos$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Gitlabconfigs$Repos$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/repos').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$Gitlabconfigs$Repos$List extends StandardParameters { - /** - * The maximum number of repositories to return. The service may return fewer than this value. - */ - pageSize?: number; - /** - * A page token, received from a previous ListGitLabRepositoriesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGitLabRepositoriesRequest` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. Name of the parent resource. - */ - parent?: string; - } - export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -10333,7 +8729,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", @@ -10368,7 +8763,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", @@ -10671,7 +9065,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", @@ -10986,7 +9379,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", @@ -11021,7 +9413,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", @@ -12448,7 +10839,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", @@ -12483,7 +10873,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", @@ -12788,7 +11177,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", @@ -13102,7 +11490,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", @@ -13137,7 +11524,6 @@ export namespace cloudbuild_v1 { * // "filter": "my_filter", * // "gitFileSource": {}, * // "github": {}, - * // "gitlabEnterpriseEventsConfig": {}, * // "id": "my_id", * // "ignoredFiles": [], * // "includeBuildLogs": "my_includeBuildLogs", diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index 5eaff8abe23..297473c112d 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -308,7 +308,7 @@ export namespace clouderrorreporting_v1beta1 { */ eventTime?: string | null; /** - * Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack). + * Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, Go, and Rust. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack). * **Rust**: Must contain standard [`std::backtrace`](https://doc.rust-lang.org/std/backtrace/index.html) frames. Requires `RUST_BACKTRACE=1` and debug symbols enabled. */ message?: string | null; /** diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index f78b1c4b394..999787cda87 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -112,6 +112,7 @@ export namespace cloudidentity_v1 { */ export class Cloudidentity { context: APIRequestContext; + allowlistedDomains: Resource$Allowlisteddomains; customers: Resource$Customers; devices: Resource$Devices; groups: Resource$Groups; @@ -126,6 +127,7 @@ export namespace cloudidentity_v1 { google, }; + this.allowlistedDomains = new Resource$Allowlisteddomains(this.context); this.customers = new Resource$Customers(this.context); this.devices = new Resource$Devices(this.context); this.groups = new Resource$Groups(this.context); @@ -160,6 +162,19 @@ export namespace cloudidentity_v1 { */ pemData?: string | null; } + /** + * This resource object defines a domain that has been designated as allowlisted. + */ + export interface Schema$AllowlistedDomain { + /** + * Required. Immutable. Name of the domain that is in the allowlist. e.g. "google.com" + */ + domain?: string | null; + /** + * Output only. Identifier. Resource name of the domain in the allowlist e.g. "allowlistedDomains/0184mhaj1smlusv" + */ + name?: string | null; + } /** * Request to cancel sent invitation for target email in UserInvitation. */ @@ -1171,6 +1186,19 @@ export namespace cloudidentity_v1 { */ isInvitableUser?: boolean | null; } + /** + * Response message for AllowlistedDomainsService.ListAllowlistedDomains. + */ + export interface Schema$ListAllowlistedDomainsResponse { + /** + * Contains the list of domains in the allowlist. There is no defined ordering of domains within a result. + */ + allowlistedDomains?: Schema$AllowlistedDomain[]; + /** + * Contains the next page token if the result is not exhaustive. If there are no more results, this token is empty. + */ + nextPageToken?: string | null; + } /** * Response message for ListGroups operation. */ @@ -1820,6 +1848,626 @@ export namespace cloudidentity_v1 { updateTime?: string | null; } + export class Resource$Allowlisteddomains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Adds a domain to the allowlist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.allowlistedDomains.create({ + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "domain": "my_domain", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Allowlisteddomains$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Allowlisteddomains$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Allowlisteddomains$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Allowlisteddomains$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Allowlisteddomains$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Allowlisteddomains$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Allowlisteddomains$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Allowlisteddomains$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/allowlistedDomains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Removes a domain from the allowlist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.allowlistedDomains.delete({ + * // Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to delete. + * name: 'allowlistedDomains/my-allowlistedDomain', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Allowlisteddomains$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Allowlisteddomains$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Allowlisteddomains$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Allowlisteddomains$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Allowlisteddomains$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Allowlisteddomains$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Allowlisteddomains$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Allowlisteddomains$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a specific domain from the allowlist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains', + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.allowlistedDomains.get({ + * // Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to retrieve. + * name: 'allowlistedDomains/my-allowlistedDomain', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "domain": "my_domain", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Allowlisteddomains$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Allowlisteddomains$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Allowlisteddomains$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Allowlisteddomains$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Allowlisteddomains$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Allowlisteddomains$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Allowlisteddomains$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Allowlisteddomains$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the domains in the allowlist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains', + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.allowlistedDomains.list({ + * // Optional. Provides an optional filter for list results. Currently, only exact matches on the domain are supported, such as "domain = 'google.com'", with no composite conditions. + * filter: 'placeholder-value', + * // Optional. Specifies the requested page size. If unspecified, the service returns at most 5000 domains. The maximum value is 5000; values above 5000 coerce to 5000. The limits can change over time. + * pageSize: 'placeholder-value', + * // Optional. Identifies a token from a previous page of results, if any. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "allowlistedDomains": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Allowlisteddomains$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Allowlisteddomains$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Allowlisteddomains$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Allowlisteddomains$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Allowlisteddomains$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Allowlisteddomains$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Allowlisteddomains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Allowlisteddomains$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/allowlistedDomains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Allowlisteddomains$Create extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$AllowlistedDomain; + } + export interface Params$Resource$Allowlisteddomains$Delete extends StandardParameters { + /** + * Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to delete. + */ + name?: string; + } + export interface Params$Resource$Allowlisteddomains$Get extends StandardParameters { + /** + * Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to retrieve. + */ + name?: string; + } + export interface Params$Resource$Allowlisteddomains$List extends StandardParameters { + /** + * Optional. Provides an optional filter for list results. Currently, only exact matches on the domain are supported, such as "domain = 'google.com'", with no composite conditions. + */ + filter?: string; + /** + * Optional. Specifies the requested page size. If unspecified, the service returns at most 5000 domains. The maximum value is 5000; values above 5000 coerce to 5000. The limits can change over time. + */ + pageSize?: number; + /** + * Optional. Identifies a token from a previous page of results, if any. + */ + pageToken?: string; + } + export class Resource$Customers { context: APIRequestContext; userinvitations: Resource$Customers$Userinvitations; diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index a5413217ea2..3831f176fe5 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -112,6 +112,7 @@ export namespace cloudidentity_v1beta1 { */ export class Cloudidentity { context: APIRequestContext; + allowlistedDomains: Resource$Allowlisteddomains; customers: Resource$Customers; devices: Resource$Devices; groups: Resource$Groups; @@ -127,6 +128,7 @@ export namespace cloudidentity_v1beta1 { google, }; + this.allowlistedDomains = new Resource$Allowlisteddomains(this.context); this.customers = new Resource$Customers(this.context); this.devices = new Resource$Devices(this.context); this.groups = new Resource$Groups(this.context); @@ -162,6 +164,19 @@ export namespace cloudidentity_v1beta1 { */ pemData?: string | null; } + /** + * This resource object defines a domain that has been designated as allowlisted. + */ + export interface Schema$AllowlistedDomain { + /** + * Required. Immutable. Name of the domain that is in the allowlist. e.g. "google.com" + */ + domain?: string | null; + /** + * Output only. Identifier. Resource name of the domain in the allowlist e.g. "allowlistedDomains/0184mhaj1smlusv" + */ + name?: string | null; + } /** * Resource representing the Android specific attributes of a Device. */ @@ -1646,6 +1661,19 @@ export namespace cloudidentity_v1beta1 { */ isInvitableUser?: boolean | null; } + /** + * Response message for AllowlistedDomainsService.ListAllowlistedDomains. + */ + export interface Schema$ListAllowlistedDomainsResponse { + /** + * Contains the list of domains in the allowlist. There is no defined ordering of domains within a result. + */ + allowlistedDomains?: Schema$AllowlistedDomain[]; + /** + * Contains the next page token if the result is not exhaustive. If there are no more results, this token is empty. + */ + nextPageToken?: string | null; + } /** * Response message that is returned in LRO result of ListClientStates Operation. */ @@ -2489,6 +2517,626 @@ export namespace cloudidentity_v1beta1 { deviceUser?: Schema$DeviceUser; } + export class Resource$Allowlisteddomains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Adds a domain to the allowlist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.allowlistedDomains.create({ + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "domain": "my_domain", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Allowlisteddomains$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Allowlisteddomains$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Allowlisteddomains$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Allowlisteddomains$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Allowlisteddomains$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Allowlisteddomains$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Allowlisteddomains$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Allowlisteddomains$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/allowlistedDomains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Removes a domain from the allowlist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.allowlistedDomains.delete({ + * // Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to delete. + * name: 'allowlistedDomains/my-allowlistedDomain', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Allowlisteddomains$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Allowlisteddomains$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Allowlisteddomains$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Allowlisteddomains$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Allowlisteddomains$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Allowlisteddomains$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Allowlisteddomains$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Allowlisteddomains$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.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); + } + } + + /** + * Retrieves a specific domain from the allowlist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains', + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.allowlistedDomains.get({ + * // Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to retrieve. + * name: 'allowlistedDomains/my-allowlistedDomain', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "domain": "my_domain", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Allowlisteddomains$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Allowlisteddomains$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Allowlisteddomains$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Allowlisteddomains$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Allowlisteddomains$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Allowlisteddomains$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Allowlisteddomains$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Allowlisteddomains$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.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 the domains in the allowlist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains', + * 'https://www.googleapis.com/auth/cloud-identity.allowlisteddomains.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.allowlistedDomains.list({ + * // Optional. Provides an optional filter for list results. Currently, only exact matches on the domain are supported, such as "domain = 'google.com'", with no composite conditions. + * filter: 'placeholder-value', + * // Optional. Specifies the requested page size. If unspecified, the service returns at most 5000 domains. The maximum value is 5000; values above 5000 coerce to 5000. The limits can change over time. + * pageSize: 'placeholder-value', + * // Optional. Identifies a token from a previous page of results, if any. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "allowlistedDomains": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Allowlisteddomains$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Allowlisteddomains$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Allowlisteddomains$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Allowlisteddomains$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Allowlisteddomains$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Allowlisteddomains$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Allowlisteddomains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Allowlisteddomains$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/allowlistedDomains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Allowlisteddomains$Create extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$AllowlistedDomain; + } + export interface Params$Resource$Allowlisteddomains$Delete extends StandardParameters { + /** + * Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to delete. + */ + name?: string; + } + export interface Params$Resource$Allowlisteddomains$Get extends StandardParameters { + /** + * Required. Specifies the [resource name](https://google.aip.dev/122) of the domain to retrieve. + */ + name?: string; + } + export interface Params$Resource$Allowlisteddomains$List extends StandardParameters { + /** + * Optional. Provides an optional filter for list results. Currently, only exact matches on the domain are supported, such as "domain = 'google.com'", with no composite conditions. + */ + filter?: string; + /** + * Optional. Specifies the requested page size. If unspecified, the service returns at most 5000 domains. The maximum value is 5000; values above 5000 coerce to 5000. The limits can change over time. + */ + pageSize?: number; + /** + * Optional. Identifies a token from a previous page of results, if any. + */ + pageToken?: string; + } + export class Resource$Customers { context: APIRequestContext; userinvitations: Resource$Customers$Userinvitations; diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 0e683373f96..67e2a35e700 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -265,7 +265,7 @@ export namespace cloudkms_v1 { logType?: string | null; } /** - * Cloud KMS Autokey configuration for a folder. + * Cloud KMS Autokey configuration for a project or folder. */ export interface Schema$AutokeyConfig { /** @@ -802,7 +802,7 @@ export namespace cloudkms_v1 { */ export interface Schema$ExternalProtectionLevelOptions { /** - * Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/x/locations/x/ekmConnections/x`. + * Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the crypto_key_backend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/x/locations/x/ekmConnections/x`. */ ekmConnectionBackendOverride?: string | null; /** @@ -1699,7 +1699,7 @@ export namespace cloudkms_v1 { updateMask?: string | null; } /** - * Response message for ShowEffectiveAutokeyConfig. + * Response message for ShowEffectiveAutokeyConfig */ export interface Schema$ShowEffectiveAutokeyConfigResponse { /** @@ -2238,7 +2238,7 @@ export namespace cloudkms_v1 { } /** - * Returns the effective Cloud KMS Autokey configuration for a given project or folder. + * Returns the effective Cloud KMS Autokey configuration for a given project or folder. Note on permissions: - If called on a project (`projects/{project\}`), requires `cloudkms.projects.showEffectiveAutokeyConfig`. - If called on a folder (`folders/{folder\}`), requires `cloudkms.folders.showEffectiveAutokeyConfig`. * @example * ```js * // Before running the sample: @@ -2271,7 +2271,7 @@ export namespace cloudkms_v1 { * * // Do the magic * const res = await cloudkms.folders.showEffectiveAutokeyConfig({ - * // Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project\} * folders/{folder\} + * // Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for evaluating the effect of nested folder configurations on a given resource project. Format: * projects/{project\} * folders/{folder\} * parent: 'folders/my-folder', * }); * console.log(res.data); @@ -2722,7 +2722,7 @@ export namespace cloudkms_v1 { } export interface Params$Resource$Folders$Showeffectiveautokeyconfig extends StandardParameters { /** - * Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project\} * folders/{folder\} + * Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for evaluating the effect of nested folder configurations on a given resource project. Format: * projects/{project\} * folders/{folder\} */ parent?: string; } @@ -3397,7 +3397,7 @@ export namespace cloudkms_v1 { } /** - * Returns the effective Cloud KMS Autokey configuration for a given project or folder. + * Returns the effective Cloud KMS Autokey configuration for a given project or folder. Note on permissions: - If called on a project (`projects/{project\}`), requires `cloudkms.projects.showEffectiveAutokeyConfig`. - If called on a folder (`folders/{folder\}`), requires `cloudkms.folders.showEffectiveAutokeyConfig`. * @example * ```js * // Before running the sample: @@ -3430,7 +3430,7 @@ export namespace cloudkms_v1 { * * // Do the magic * const res = await cloudkms.projects.showEffectiveAutokeyConfig({ - * // Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project\} * folders/{folder\} + * // Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for evaluating the effect of nested folder configurations on a given resource project. Format: * projects/{project\} * folders/{folder\} * parent: 'projects/my-project', * }); * console.log(res.data); @@ -4189,7 +4189,7 @@ export namespace cloudkms_v1 { } export interface Params$Resource$Projects$Showeffectiveautokeyconfig extends StandardParameters { /** - * Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project\} * folders/{folder\} + * Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for evaluating the effect of nested folder configurations on a given resource project. Format: * projects/{project\} * folders/{folder\} */ parent?: string; } diff --git a/src/apis/cloudnumberregistry/v1alpha.ts b/src/apis/cloudnumberregistry/v1alpha.ts index 1f86a3f6db6..1915ed70697 100644 --- a/src/apis/cloudnumberregistry/v1alpha.ts +++ b/src/apis/cloudnumberregistry/v1alpha.ts @@ -112,6 +112,7 @@ export namespace cloudnumberregistry_v1alpha { */ export class Cloudnumberregistry { context: APIRequestContext; + organizations: Resource$Organizations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace cloudnumberregistry_v1alpha { google, }; + this.organizations = new Resource$Organizations(this.context); this.projects = new Resource$Projects(this.context); } } @@ -481,6 +483,23 @@ export namespace cloudnumberregistry_v1alpha { */ unreachable?: string[] | null; } + /** + * Response message for the CloudNumberRegistry.ListOrgNumberRegistries method. + */ + export interface Schema$ListOrgNumberRegistriesResponse { + /** + * A token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * The list of OrgNumberRegistries. + */ + orgNumberRegistries?: Schema$OrgNumberRegistry[]; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response message for the CloudNumberRegistry.ListRealms method. */ @@ -598,6 +617,35 @@ export namespace cloudnumberregistry_v1alpha { */ verb?: string | null; } + /** + * An OrgNumberRegistry defines a delegation of authority from an organization to a project, allowing the project to manage IP address data within specified scopes of the organization. + */ + export interface Schema$OrgNumberRegistry { + /** + * Required. The project that will act as the admin project for CNR resources Format: projects/{project_number\} or projects/{project_id\} + */ + adminProject?: string | null; + /** + * Output only. The time at which the OrgNumberRegistry was created. + */ + createTime?: string | null; + /** + * Optional. User-defined labels. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the OrgNumberRegistry. + */ + name?: string | null; + /** + * Required. The scopes within the organization that the project is able to manage. Currently only organization scope is supported. For example, "organizations/1234567890". + */ + targetScopes?: string[] | null; + /** + * Output only. The time at which the OrgNumberRegistry was last updated. + */ + updateTime?: string | null; + } /** * Represents either a CustomRange or a DiscoveredRange. */ @@ -830,6 +878,1317 @@ export namespace cloudnumberregistry_v1alpha { message?: string | null; } + export class Resource$Organizations { + context: APIRequestContext; + locations: Resource$Organizations$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Organizations$Locations(this.context); + } + } + + export class Resource$Organizations$Locations { + context: APIRequestContext; + operations: Resource$Organizations$Locations$Operations; + orgNumberRegistries: Resource$Organizations$Locations$Orgnumberregistries; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Organizations$Locations$Operations( + this.context + ); + this.orgNumberRegistries = + new Resource$Organizations$Locations$Orgnumberregistries(this.context); + } + } + + export class Resource$Organizations$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.organizations.locations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'organizations/my-organization/locations/my-location/operations/my-operation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Organizations$Locations$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.organizations.locations.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'organizations/my-organization/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Organizations$Locations$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.organizations.locations.operations.get({ + * // The name of the operation resource. + * name: 'organizations/my-organization/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Organizations$Locations$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Organizations$Locations$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Organizations$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudnumberregistry.organizations.locations.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'organizations/my-organization/locations/my-location', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Organizations$Locations$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Organizations$Locations$Operations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Organizations$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Operations$List, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Organizations$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$Organizations$Locations$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Operations$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Organizations$Locations$Orgnumberregistries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new OrgNumberRegistry in a given organization and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.organizations.locations.orgNumberRegistries.create( + * { + * // Required. The ID to use for the OrgNumberRegistry, which will become the final segment of the resource name. + * orgNumberRegistryId: 'placeholder-value', + * // Required. The parent resource name where the OrgNumberRegistry will be created. + * parent: 'organizations/my-organization/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adminProject": "my_adminProject", + * // "createTime": "my_createTime", + * // "labels": {}, + * // "name": "my_name", + * // "targetScopes": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Organizations$Locations$Orgnumberregistries$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Orgnumberregistries$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Orgnumberregistries$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Orgnumberregistries$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/orgNumberRegistries').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 OrgNumberRegistry. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.organizations.locations.orgNumberRegistries.delete( + * { + * // Required. The resource name of the OrgNumberRegistry to delete. + * name: 'organizations/my-organization/locations/my-location/orgNumberRegistries/my-orgNumberRegistrie', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Organizations$Locations$Orgnumberregistries$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Orgnumberregistries$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Orgnumberregistries$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Orgnumberregistries$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single OrgNumberRegistry. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.organizations.locations.orgNumberRegistries.get({ + * // Required. The resource name of the OrgNumberRegistry to retrieve. + * name: 'organizations/my-organization/locations/my-location/orgNumberRegistries/my-orgNumberRegistrie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "adminProject": "my_adminProject", + * // "createTime": "my_createTime", + * // "labels": {}, + * // "name": "my_name", + * // "targetScopes": [], + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Organizations$Locations$Orgnumberregistries$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Orgnumberregistries$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Orgnumberregistries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Orgnumberregistries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists OrgNumberRegistries in a given organization and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudnumberregistry.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudnumberregistry = google.cloudnumberregistry('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await cloudnumberregistry.organizations.locations.orgNumberRegistries.list({ + * // Optional. Filter expression to filter the results. + * filter: 'placeholder-value', + * // Optional. Hint for how to order the results. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. + * pageToken: 'placeholder-value', + * // Required. The parent resource name, for example `organizations/x/locations/x`. + * parent: 'organizations/my-organization/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "orgNumberRegistries": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Organizations$Locations$Orgnumberregistries$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Orgnumberregistries$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Orgnumberregistries$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Orgnumberregistries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Orgnumberregistries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudnumberregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/orgNumberRegistries').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$Organizations$Locations$Orgnumberregistries$Create extends StandardParameters { + /** + * Required. The ID to use for the OrgNumberRegistry, which will become the final segment of the resource name. + */ + orgNumberRegistryId?: string; + /** + * Required. The parent resource name where the OrgNumberRegistry will be created. + */ + 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 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; + + /** + * Request body metadata + */ + requestBody?: Schema$OrgNumberRegistry; + } + export interface Params$Resource$Organizations$Locations$Orgnumberregistries$Delete extends StandardParameters { + /** + * Required. The resource name of the OrgNumberRegistry to delete. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Organizations$Locations$Orgnumberregistries$Get extends StandardParameters { + /** + * Required. The resource name of the OrgNumberRegistry to retrieve. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Orgnumberregistries$List extends StandardParameters { + /** + * Optional. Filter expression to filter the results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent resource name, for example `organizations/x/locations/x`. + */ + parent?: string; + } + export class Resource$Projects { context: APIRequestContext; locations: Resource$Projects$Locations; diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index 499f3ad3072..3d40b11f42d 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -1968,9 +1968,13 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1GcsSource { /** - * Cloud Storage URI that points to a file that contains the conversation audio. + * Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio. */ audioUri?: string | null; + /** + * Immutable. Cloud Storage URIs that point to files that contain the conversation audio. Supports both single audio files and multi-leg session recordings (e.g., call transfers, rolling recording buffers). + */ + audioUris?: string[] | null; /** * Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. */ @@ -5988,9 +5992,13 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1GcsSource { /** - * Cloud Storage URI that points to a file that contains the conversation audio. + * Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio. */ audioUri?: string | null; + /** + * Immutable. Cloud Storage URIs that point to files that contain the conversation audio. Supports both single audio files and multi-leg session recordings (e.g., call transfers, rolling recording buffers). + */ + audioUris?: string[] | null; /** * Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. */ @@ -8788,9 +8796,13 @@ export namespace contactcenterinsights_v1 { */ export interface Schema$GoogleCloudContactcenterinsightsV1mainGcsSource { /** - * Cloud Storage URI that points to a file that contains the conversation audio. + * Immutable. Deprecated: Use `audio_uris` instead. Cloud Storage URI that points to a file that contains the conversation audio. */ audioUri?: string | null; + /** + * Immutable. Cloud Storage URIs that point to files that contain the conversation audio. Supports both single audio files and multi-leg session recordings (e.g., call transfers, rolling recording buffers). + */ + audioUris?: string[] | null; /** * Immutable. Cloud Storage URI that points to a file that contains the conversation transcript. */ @@ -11758,6 +11770,10 @@ export namespace contactcenterinsights_v1 { * The signed URI for the audio from the Cloud Storage conversation source. */ signedGcsAudioUri?: string | null; + /** + * Output only. The signed URIs for the audio from the Cloud Storage conversation source when multiple audio files exist (e.g. multi-leg conversations). + */ + signedGcsAudioUris?: string[] | null; /** * The signed URI for the audio corresponding to each turn in the conversation. */ diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index 79541543409..02b535191d2 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -1294,6 +1294,10 @@ export namespace containeranalysis_v1 { * Required. Where should the files be placed on the worker. */ destPath?: string | null; + /** + * Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags. + */ + fetchTags?: boolean | null; /** * Optional. True if submodules should be fetched too (default false). */ diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index df97e4a2f74..1e30d7cbac1 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -1277,6 +1277,10 @@ export namespace containeranalysis_v1alpha1 { * Required. Where should the files be placed on the worker. */ destPath?: string | null; + /** + * Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags. + */ + fetchTags?: boolean | null; /** * Optional. True if submodules should be fetched too (default false). */ diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index 2800d5dc096..82899c92acd 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -1191,6 +1191,10 @@ export namespace containeranalysis_v1beta1 { * Required. Where should the files be placed on the worker. */ destPath?: string | null; + /** + * Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags. + */ + fetchTags?: boolean | null; /** * Optional. True if submodules should be fetched too (default false). */ diff --git a/src/apis/dataform/v1beta1.ts b/src/apis/dataform/v1beta1.ts index b107688fcf3..1ad9febfab7 100644 --- a/src/apis/dataform/v1beta1.ts +++ b/src/apis/dataform/v1beta1.ts @@ -247,6 +247,19 @@ export namespace dataform_v1beta1 { */ role?: string | null; } + /** + * Contains metadata about a branch. + */ + export interface Schema$BranchMetadata { + /** + * The branch name. + */ + branchName?: string | null; + /** + * The last commit on the branch. + */ + lastCommit?: Schema$CommitLogEntry; + } /** * The request message for Operations.CancelOperation. */ @@ -259,6 +272,23 @@ export namespace dataform_v1beta1 { * `CancelWorkflowInvocation` response message. */ export interface Schema$CancelWorkflowInvocationResponse {} + /** + * `CheckoutWorkspaceBranch` request message. + */ + export interface Schema$CheckoutWorkspaceBranchRequest { + /** + * Required. The name of the branch in the Git repository to which the workspace should be checked out. + */ + branch?: string | null; + /** + * Optional. If set to true and the branch does not exist, it will be created. Otherwise, an error will be thrown. + */ + createIfNotExists?: boolean | null; + /** + * Optional. The name of the branch in the Git repository from which the new branch should be created. If left unset, the workspace's current branch name will be used. Accepts only branch names from FetchWorkspaceBranches response, and can only be set if `create_if_not_exists` is true. Oherwise, an error will be thrown. + */ + sourceBranch?: string | null; + } /** * Configures various aspects of Dataform code compilation. */ @@ -632,6 +662,23 @@ export namespace dataform_v1beta1 { */ relationDescriptor?: Schema$RelationDescriptor; } + /** + * `DeleteBranch` request message. + */ + export interface Schema$DeleteBranchRequest { + /** + * Required. The name of the branch in the Git repository to delete. + */ + branch?: string | null; + /** + * Optional. If set to true, any non-pushed commits on the branch will be deleted. Upstream branch name will be the same as the branch to delete. + */ + force?: boolean | null; + } + /** + * `DeleteBranch` response message. + */ + export interface Schema$DeleteBranchResponse {} /** * Represents the delete file operation. */ @@ -727,6 +774,15 @@ export namespace dataform_v1beta1 { */ title?: string | null; } + /** + * Response message for `FetchCurrentWorkspaceBranch` method. + */ + export interface Schema$FetchCurrentWorkspaceBranchResponse { + /** + * The name of the current branch for the workspace. + */ + branchName?: string | null; + } /** * `FetchFileDiff` response message. */ @@ -780,6 +836,19 @@ export namespace dataform_v1beta1 { */ nextPageToken?: string | null; } + /** + * Response message for `FetchWorkspaceBranches` method. + */ + export interface Schema$FetchWorkspaceBranchesResponse { + /** + * The branches in the workspace. + */ + branches?: Schema$BranchMetadata[]; + /** + * 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; + } /** * Represents a single file operation to the repository. */ @@ -1999,6 +2068,23 @@ export namespace dataform_v1beta1 { */ message?: string | null; } + /** + * `SyncWorkspaceRefs` request message. + */ + export interface Schema$SyncWorkspaceRefsRequest { + /** + * Optional. Can be used to deepen the commit history of shallow clones. Git documentation: https://git-scm.com/docs/git-fetch#Documentation/git-fetch.txt---deependepth + */ + deepen?: number | null; + /** + * Optional. The name of the branch in the Git remote to which the refs should be fetched for. If left unset, all remote branches will be fetched. + */ + remoteBranchName?: string | null; + } + /** + * `SyncWorkspaceRefs` response message. + */ + export interface Schema$SyncWorkspaceRefsResponse {} /** * Represents a table update trigger configuration. */ @@ -2313,10 +2399,18 @@ export namespace dataform_v1beta1 { * Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. */ dataEncryptionState?: Schema$DataEncryptionState; + /** + * Optional. Input only. Immutable. The maximum depth of the Git repository to checkout for this workspace. If defined and greater than 0, the Git repository will be created as a shallow clone with the given depth, otherwise a full clone will be performed. This field is available only for GitHub, Gitlab and 1p repositories with enabled branch management. + */ + depth?: number | null; /** * Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted. */ disableMoves?: boolean | null; + /** + * Immutable. Controls the enablement of branch checkout for the workspace. When set to True, the workspace will be allowed to checkout branches. + */ + enableBranchManagement?: boolean | null; /** * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. */ @@ -2325,10 +2419,18 @@ export namespace dataform_v1beta1 { * Identifier. The workspace's name. */ name?: string | null; + /** + * Optional. Input only. Immutable. The name of the default upstream branch for all pull/push operations in the remote repository for this workspace. If empty, the HEAD branch from repository will be used. + */ + originalBranch?: string | null; /** * Output only. Metadata indicating whether this resource is user-scoped. For `Workspace` resources, the `user_scoped` field is always `true`. */ privateResourceMetadata?: Schema$PrivateResourceMetadata; + /** + * Output only. If set to true, the workspace was created as a shallow clone. Will be set to true if the depth field is set to a value greater than 0, otherwise it will be set to false. + */ + shallow?: boolean | null; } /** * Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` can have a special expression - `${workspaceName\}`, which refers to the workspace name from which the compilation results will be created. API callers are expected to resolve the expression in these overrides and provide them explicitly in `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. @@ -11531,6 +11633,155 @@ export namespace dataform_v1beta1 { this.context = context; } + /** + * Checkout a branch in a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.checkout({ + * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "branch": "my_branch", + * // "createIfNotExists": false, + * // "sourceBranch": "my_sourceBranch" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + checkout( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, + options: StreamMethodOptions + ): Promise>; + checkout( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, + options?: MethodOptions + ): Promise>; + checkout( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkout( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkout( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, + callback: BodyResponseCallback + ): void; + checkout(callback: BodyResponseCallback): void; + checkout( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:checkout').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); + } + } + /** * Applies a Git commit for uncommitted files in a Workspace. * @example @@ -11732,10 +11983,14 @@ export namespace dataform_v1beta1 { * // { * // "createTime": "my_createTime", * // "dataEncryptionState": {}, + * // "depth": 0, * // "disableMoves": false, + * // "enableBranchManagement": false, * // "internalMetadata": "my_internalMetadata", * // "name": "my_name", - * // "privateResourceMetadata": {} + * // "originalBranch": "my_originalBranch", + * // "privateResourceMetadata": {}, + * // "shallow": false * // } * }, * }); @@ -11745,10 +12000,14 @@ export namespace dataform_v1beta1 { * // { * // "createTime": "my_createTime", * // "dataEncryptionState": {}, + * // "depth": 0, * // "disableMoves": false, + * // "enableBranchManagement": false, * // "internalMetadata": "my_internalMetadata", * // "name": "my_name", - * // "privateResourceMetadata": {} + * // "originalBranch": "my_originalBranch", + * // "privateResourceMetadata": {}, + * // "shallow": false * // } * } * @@ -11983,7 +12242,7 @@ export namespace dataform_v1beta1 { } /** - * Fetches Git diff for an uncommitted file in a Workspace. + * Deletes a branch in a Workspace. * @example * ```js * // Before running the sample: @@ -12016,19 +12275,23 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({ - * // Required. The file's full path including filename, relative to the workspace root. - * path: 'placeholder-value', - * // Required. The workspace's name. - * workspace: - * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * await dataform.projects.locations.repositories.workspaces.deleteBranch({ + * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "branch": "my_branch", + * // "force": false + * // } + * }, * }); * console.log(res.data); * * // Example response - * // { - * // "formattedDiff": "my_formattedDiff" - * // } + * // {} * } * * main().catch(e => { @@ -12043,57 +12306,57 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchFileDiff( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + deleteBranch( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, options: StreamMethodOptions ): Promise>; - fetchFileDiff( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + deleteBranch( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, options?: MethodOptions - ): Promise>; - fetchFileDiff( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + ): Promise>; + deleteBranch( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchFileDiff( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + deleteBranch( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchFileDiff( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, - callback: BodyResponseCallback + deleteBranch( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, + callback: BodyResponseCallback ): void; - fetchFileDiff( - callback: BodyResponseCallback + deleteBranch( + callback: BodyResponseCallback ): void; - fetchFileDiff( + deleteBranch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch; options = {}; } @@ -12106,32 +12369,32 @@ export namespace dataform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+workspace}:fetchFileDiff').replace( + url: (rootUrl + '/v1beta1/{+name}:deleteBranch').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['workspace'], - pathParams: ['workspace'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Fetches Git statuses for the files in a Workspace. + * Fetches branches in a Workspace. * @example * ```js * // Before running the sample: @@ -12164,17 +12427,22 @@ export namespace dataform_v1beta1 { * * // Do the magic * const res = - * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses( - * { - * // Required. The workspace's name. - * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', - * }, - * ); + * await dataform.projects.locations.repositories.workspaces.fetchBranches({ + * // Optional. Filter for the returned list. + * filter: 'placeholder-value', + * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * // Optional. Maximum number of branches to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `FetchWorkspaceBranches` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchWorkspaceBranches`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "uncommittedFileChanges": [] + * // "branches": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -12190,16 +12458,468 @@ export namespace dataform_v1beta1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchFileGitStatuses( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + fetchBranches( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, options: StreamMethodOptions ): Promise>; - fetchFileGitStatuses( - params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + fetchBranches( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, options?: MethodOptions - ): Promise>; - fetchFileGitStatuses( - params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + ): Promise>; + fetchBranches( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchBranches( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchBranches( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, + callback: BodyResponseCallback + ): void; + fetchBranches( + callback: BodyResponseCallback + ): void; + fetchBranches( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:fetchBranches').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 + ); + } + } + + /** + * Fetches the current branch of a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.fetchCurrentBranch( + * { + * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "branchName": "my_branchName" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchCurrentBranch( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, + options: StreamMethodOptions + ): Promise>; + fetchCurrentBranch( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + fetchCurrentBranch( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchCurrentBranch( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchCurrentBranch( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, + callback: BodyResponseCallback + ): void; + fetchCurrentBranch( + callback: BodyResponseCallback + ): void; + fetchCurrentBranch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:fetchCurrentBranch').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 + ); + } + } + + /** + * Fetches Git diff for an uncommitted file in a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({ + * // Required. The file's full path including filename, relative to the workspace root. + * path: 'placeholder-value', + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "formattedDiff": "my_formattedDiff" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + options: StreamMethodOptions + ): Promise>; + fetchFileDiff( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + options?: MethodOptions + ): Promise>; + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + callback: BodyResponseCallback + ): void; + fetchFileDiff( + callback: BodyResponseCallback + ): void; + fetchFileDiff( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+workspace}:fetchFileDiff').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches Git statuses for the files in a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses( + * { + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "uncommittedFileChanges": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + options: StreamMethodOptions + ): Promise>; + fetchFileGitStatuses( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + options?: MethodOptions + ): Promise>; + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; @@ -12474,10 +13194,14 @@ export namespace dataform_v1beta1 { * // { * // "createTime": "my_createTime", * // "dataEncryptionState": {}, + * // "depth": 0, * // "disableMoves": false, + * // "enableBranchManagement": false, * // "internalMetadata": "my_internalMetadata", * // "name": "my_name", - * // "privateResourceMetadata": {} + * // "originalBranch": "my_originalBranch", + * // "privateResourceMetadata": {}, + * // "shallow": false * // } * } * @@ -14843,6 +15567,160 @@ export namespace dataform_v1beta1 { } } + /** + * Syncs the refs of a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.syncWorkspaceRefs( + * { + * // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deepen": 0, + * // "remoteBranchName": "my_remoteBranchName" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + syncWorkspaceRefs( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, + options: StreamMethodOptions + ): Promise>; + syncWorkspaceRefs( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, + options?: MethodOptions + ): Promise>; + syncWorkspaceRefs( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + syncWorkspaceRefs( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + syncWorkspaceRefs( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, + callback: BodyResponseCallback + ): void; + syncWorkspaceRefs( + callback: BodyResponseCallback + ): void; + syncWorkspaceRefs( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:syncWorkspaceRefs').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); + } + } + /** * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example @@ -15150,6 +16028,17 @@ export namespace dataform_v1beta1 { } } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout extends StandardParameters { + /** + * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CheckoutWorkspaceBranchRequest; + } export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Commit extends StandardParameters { /** * Required. The workspace's name. @@ -15182,6 +16071,41 @@ export namespace dataform_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch extends StandardParameters { + /** + * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeleteBranchRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches extends StandardParameters { + /** + * Optional. Filter for the returned list. + */ + filter?: string; + /** + * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + */ + name?: string; + /** + * Optional. Maximum number of branches to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `FetchWorkspaceBranches` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchWorkspaceBranches`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch extends StandardParameters { + /** + * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff extends StandardParameters { /** * Required. The file's full path including filename, relative to the workspace root. @@ -15410,6 +16334,17 @@ export namespace dataform_v1beta1 { */ requestBody?: Schema$SetIamPolicyRequest; } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs extends StandardParameters { + /** + * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SyncWorkspaceRefsRequest; + } export interface Params$Resource$Projects$Locations$Repositories$Workspaces$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. diff --git a/src/apis/developerknowledge/v1.ts b/src/apis/developerknowledge/v1.ts index d2b459853c8..6d9c1522a41 100644 --- a/src/apis/developerknowledge/v1.ts +++ b/src/apis/developerknowledge/v1.ts @@ -266,6 +266,10 @@ export namespace developerknowledge_v1 { * Output only. Contains the resource name of the document this chunk is from. Format: `documents/{uri_without_scheme\}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` */ parent?: string | null; + /** + * Output only. Represents the relevance score of the chunk to the search query. Higher score indicates higher chunk relevance. The score is in range [0.0, 1.0]. + */ + relevanceScore?: number | null; } /** * Represents a reference to a document. diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index c743100cdfb..805d49f453c 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -2105,6 +2105,7 @@ export namespace dialogflow_v2 { } export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResultError { message?: string | null; + retryable?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2beta1WebhookRequest { alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[]; @@ -3671,6 +3672,7 @@ export namespace dialogflow_v2 { } export interface Schema$GoogleCloudDialogflowV2ToolCallResultError { message?: string | null; + retryable?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2ToolConnectorTool { actions?: Schema$GoogleCloudDialogflowV2ToolConnectorToolAction[]; diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 1aab6e2f77d..3fd49a8763d 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -3095,6 +3095,7 @@ export namespace dialogflow_v2beta1 { } export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResultError { message?: string | null; + retryable?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2beta1ToolConnectorTool { actions?: Schema$GoogleCloudDialogflowV2beta1ToolConnectorToolAction[]; @@ -3753,6 +3754,7 @@ export namespace dialogflow_v2beta1 { } export interface Schema$GoogleCloudDialogflowV2ToolCallResultError { message?: string | null; + retryable?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata { conversationModel?: string | null; diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index 223b19c22ac..342d01ccee2 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -2984,6 +2984,7 @@ export namespace dialogflow_v3 { } export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResultError { message?: string | null; + retryable?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2beta1WebhookRequest { alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[]; @@ -3578,6 +3579,7 @@ export namespace dialogflow_v3 { } export interface Schema$GoogleCloudDialogflowV2ToolCallResultError { message?: string | null; + retryable?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata { conversationModel?: string | null; diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index b085df02c20..c1b586b3bc7 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -3214,6 +3214,7 @@ export namespace dialogflow_v3beta1 { } export interface Schema$GoogleCloudDialogflowV2beta1ToolCallResultError { message?: string | null; + retryable?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2beta1WebhookRequest { alternativeQueryResults?: Schema$GoogleCloudDialogflowV2beta1QueryResult[]; @@ -3808,6 +3809,7 @@ export namespace dialogflow_v3beta1 { } export interface Schema$GoogleCloudDialogflowV2ToolCallResultError { message?: string | null; + retryable?: boolean | null; } export interface Schema$GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata { conversationModel?: string | null; diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index 2bb2846add0..4ec796253c5 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -229,6 +229,10 @@ export namespace firebaseml_v2beta { * Optional. Deprecated: Use top-level `language_codes` instead. Specifies one or more languages in the audio. */ languageHints?: Schema$GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints; + /** + * Optional. Configures transcription mode. Supported values: `VERBATIM`, `SMART`. If unspecified, defaults to `VERBATIM` transcription. In `SMART` mode, the model performs disfluency removal (eliminating filler words, repetitions, and false starts), light grammatical cleanup, automatic formatting (paragraphs, bullet points, numbered lists), and minor user edits (inline self-corrections). Timestamps and diarization are incompatible with mode `SMART`. + */ + mode?: string | null; /** * Optional. Configures word-level timestamp generation. */ @@ -1528,6 +1532,10 @@ export namespace firebaseml_v2beta { * Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. */ inlineData?: Schema$GoogleCloudAiplatformV1beta1Blob; + /** + * Optional. How the model processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. + */ + mediaProcessing?: string | null; /** * per part media resolution. Media resolution for the input media. */ diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index f25493edf91..26b6e124bea 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -192,6 +192,10 @@ export namespace firestore_v1 { * Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * Reads documents in a transaction. */ @@ -226,6 +230,10 @@ export namespace firestore_v1 { * Labels associated with this batch write. */ labels?: {[key: string]: string} | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request. */ @@ -252,6 +260,10 @@ export namespace firestore_v1 { * The options for the transaction. Defaults to a read-write transaction. */ options?: Schema$TransactionOptions; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; } /** * The response for Firestore.BeginTransaction. @@ -305,6 +317,10 @@ export namespace firestore_v1 { * The request for Firestore.Commit. */ export interface Schema$CommitRequest { + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * If set, applies all writes in this transaction, and commits it. */ @@ -485,6 +501,10 @@ export namespace firestore_v1 { * Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * A pipelined operation. */ @@ -495,7 +515,7 @@ export namespace firestore_v1 { transaction?: string | null; } /** - * The response for Firestore.Execute. + * The response for Firestore.ExecutePipeline. */ export interface Schema$ExecutePipelineResponse { /** @@ -827,6 +847,43 @@ export namespace firestore_v1 { */ namespaceIds?: string[] | null; } + /** + * A Change Stream is a resource that allows users to receive change notifications from a Firestore database. + */ + export interface Schema$GoogleFirestoreAdminV1ChangeStream { + /** + * If set, the change stream is scoped to a collection group. + */ + collectionGroupScope?: Schema$GoogleFirestoreAdminV1CollectionGroupScope; + /** + * Output only. The time the Change Stream was created. + */ + createTime?: string | null; + /** + * If set, the change stream is scoped to the entire database. + */ + databaseScope?: Schema$GoogleFirestoreAdminV1DatabaseScope; + /** + * Optional. An etag used to determine which version of the configuration is being edited. + */ + etag?: string | null; + /** + * Identifier. The external resource name of the change stream. Format `projects/{project\}/databases/{database\}/changeStreams/{change_stream\}` + */ + name?: string | null; + /** + * Required. The retention period of the change stream. This is the amount of time a change event is available on the change stream. Must be from 1 to 7 days, inclusive. The retention_period must be in day granularity, i.e. it must be a multiple of 24 hours. + */ + retentionPeriod?: string | null; + /** + * Output only. The time the Change Stream started recording events. + */ + startTime?: string | null; + /** + * Output only. The time the Change Stream was last updated. + */ + updateTime?: string | null; + } /** * Metadata for the long-running operation from the CloneDatabase request. */ @@ -890,6 +947,15 @@ export namespace firestore_v1 { */ kmsKeyName?: string | null; } + /** + * The change stream is scoped to a collection group. Only events associated with the given collection group are visible to the Change Stream. Only a single change stream can be enabled per collection group. + */ + export interface Schema$GoogleFirestoreAdminV1CollectionGroupScope { + /** + * Required. The collection group name. + */ + collectionGroupId?: string | null; + } /** * Metadata related to the create database operation. */ @@ -948,7 +1014,7 @@ export namespace firestore_v1 { */ etag?: string | null; /** - * Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. + * Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard edition. */ firestoreDataAccessMode?: string | null; /** @@ -964,7 +1030,7 @@ export namespace firestore_v1 { */ locationId?: string | null; /** - * Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. + * Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard edition. */ mongodbCompatibleDataAccessMode?: string | null; /** @@ -1008,6 +1074,10 @@ export namespace firestore_v1 { */ versionRetentionPeriod?: string | null; } + /** + * The change stream is scoped to the entire database. All events in the database are visible to the Change Stream. One Database scope Change Stream is allowed per database. + */ + export interface Schema$GoogleFirestoreAdminV1DatabaseScope {} /** * Metadata related to the delete database operation. */ @@ -1225,7 +1295,7 @@ export namespace firestore_v1 { namespaceIds?: string[] | null; } /** - * Cloud Firestore indexes enable simple and complex queries against documents in a database. + * Cloud Firestore indexes enable simple and complex queries against documents in a database. In Standard edition databases, single-field indexes are managed using the google.firestore.admin.v1.Field resource, and composite indexes are managed using the google.firestore.admin.v1.Index resource. In Enterprise edition databases, both single-field and composite indexes are managed using the google.firestore.admin.v1.Index resource. */ export interface Schema$GoogleFirestoreAdminV1Index { /** @@ -1237,7 +1307,7 @@ export namespace firestore_v1 { */ density?: string | null; /** - * The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. + * The fields supported by this index. At most 100 fields may be specified. In Standard edition databases only: - At least 2 fields must be specified. - The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in the index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). */ fields?: Schema$GoogleFirestoreAdminV1IndexField[]; /** @@ -1245,7 +1315,7 @@ export namespace firestore_v1 { */ multikey?: boolean | null; /** - * Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/indexes/{composite_index_id\}` For single field indexes, this field will be empty. + * A server-defined name for this index. Output only. When used in the google.firestore.admin.v1.Index resource, the value is of the form: `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/indexes/{index_id\}` When used in the google.firestore.admin.v1.Field resource, the value is empty. */ name?: string | null; /** @@ -1379,6 +1449,15 @@ export namespace firestore_v1 { */ unreachable?: string[] | null; } + /** + * Response to FirestoreAdmin.ListChangeStreams. + */ + export interface Schema$GoogleFirestoreAdminV1ListChangeStreamsResponse { + /** + * The list of change streams. + */ + changeStreams?: Schema$GoogleFirestoreAdminV1ChangeStream[]; + } /** * The list of databases for a project. */ @@ -1644,7 +1723,20 @@ export namespace firestore_v1 { /** * Metadata related to the update database operation. */ - export interface Schema$GoogleFirestoreAdminV1UpdateDatabaseMetadata {} + export interface Schema$GoogleFirestoreAdminV1UpdateDatabaseMetadata { + /** + * The time this operation completed. Will be unset if operation still in progress. + */ + endTime?: string | null; + /** + * The time this operation started. + */ + startTime?: string | null; + /** + * The state of the operation. + */ + state?: string | null; + } /** * A Cloud Firestore User Creds. */ @@ -1771,6 +1863,10 @@ export namespace firestore_v1 { * Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; } /** * The response from Firestore.ListCollectionIds. @@ -1814,6 +1910,10 @@ export namespace firestore_v1 { * The ID of a target to remove from this stream. */ removeTarget?: number | null; + /** + * Optional. The request options for the request. + */ + requestOptions?: Schema$RequestOptions; } /** * The response for Firestore.Listen. @@ -1920,6 +2020,10 @@ export namespace firestore_v1 { * Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for the request. + */ + requestOptions?: Schema$RequestOptions; /** * A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. */ @@ -2013,10 +2117,23 @@ export namespace firestore_v1 { */ retryTransaction?: string | null; } + /** + * Options for a server request. + */ + export interface Schema$RequestOptions { + /** + * Optional. The request tags for the request. + */ + requestTags?: string[] | null; + } /** * The request for Firestore.Rollback. */ export interface Schema$RollbackRequest { + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * Required. The transaction to roll back. */ @@ -2038,6 +2155,10 @@ export namespace firestore_v1 { * Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for the request. + */ + requestOptions?: Schema$RequestOptions; /** * An aggregation query. */ @@ -2084,6 +2205,10 @@ export namespace firestore_v1 { * Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * A structured query. */ @@ -2321,7 +2446,7 @@ export namespace firestore_v1 { */ export interface Schema$Value { /** - * An array value. Cannot directly contain another array value, though can contain a map which contains another array. + * An array value. In Standard edition databases, an array value cannot directly contain another array value, though it can contain a map which contains another array. In Enterprise edition databases, an array value can contain another array value. */ arrayValue?: Schema$ArrayValue; /** @@ -2329,7 +2454,7 @@ export namespace firestore_v1 { */ booleanValue?: boolean | null; /** - * A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + * A bytes value. In Standard edition databases: * The value must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits. */ bytesValue?: string | null; /** @@ -2369,7 +2494,7 @@ export namespace firestore_v1 { */ referenceValue?: string | null; /** - * A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + * A string value. In Standard edition databases: * The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes of the UTF-8 representation are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits. */ stringValue?: string | null; /** @@ -2418,6 +2543,10 @@ export namespace firestore_v1 { * Labels associated with this write request. */ labels?: {[key: string]: string} | null; + /** + * Optional. The request options for the request. + */ + requestOptions?: Schema$RequestOptions; /** * The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. */ @@ -2480,6 +2609,7 @@ export namespace firestore_v1 { export class Resource$Projects$Databases { context: APIRequestContext; backupSchedules: Resource$Projects$Databases$Backupschedules; + changeStreams: Resource$Projects$Databases$Changestreams; collectionGroups: Resource$Projects$Databases$Collectiongroups; documents: Resource$Projects$Databases$Documents; operations: Resource$Projects$Databases$Operations; @@ -2489,6 +2619,9 @@ export namespace firestore_v1 { this.backupSchedules = new Resource$Projects$Databases$Backupschedules( this.context ); + this.changeStreams = new Resource$Projects$Databases$Changestreams( + this.context + ); this.collectionGroups = new Resource$Projects$Databases$Collectiongroups( this.context ); @@ -5046,29 +5179,14 @@ export namespace firestore_v1 { requestBody?: Schema$GoogleFirestoreAdminV1BackupSchedule; } - export class Resource$Projects$Databases$Collectiongroups { - context: APIRequestContext; - fields: Resource$Projects$Databases$Collectiongroups$Fields; - indexes: Resource$Projects$Databases$Collectiongroups$Indexes; - constructor(context: APIRequestContext) { - this.context = context; - this.fields = new Resource$Projects$Databases$Collectiongroups$Fields( - this.context - ); - this.indexes = new Resource$Projects$Databases$Collectiongroups$Indexes( - this.context - ); - } - } - - export class Resource$Projects$Databases$Collectiongroups$Fields { + export class Resource$Projects$Databases$Changestreams { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets the metadata and configuration for a Field. + * Creates a new change stream for the database. * @example * ```js * // Before running the sample: @@ -5100,17 +5218,39 @@ export namespace firestore_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await firestore.projects.databases.collectionGroups.fields.get({ - * // Required. A name of the form `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/fields/{field_id\}` - * name: 'projects/my-project/databases/my-database/collectionGroups/my-collectionGroup/fields/my-field', + * const res = await firestore.projects.databases.changeStreams.create({ + * // Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value should be 4-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character must be a letter or a number. + * changeStreamId: 'placeholder-value', + * // Required. The parent database to create the change stream for. Format is `projects/{project\}/databases/{database\}`. + * parent: 'projects/my-project/databases/my-database', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "collectionGroupScope": {}, + * // "createTime": "my_createTime", + * // "databaseScope": {}, + * // "etag": "my_etag", + * // "name": "my_name", + * // "retentionPeriod": "my_retentionPeriod", + * // "startTime": "my_startTime", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "indexConfig": {}, + * // "collectionGroupScope": {}, + * // "createTime": "my_createTime", + * // "databaseScope": {}, + * // "etag": "my_etag", * // "name": "my_name", - * // "ttlConfig": {} + * // "retentionPeriod": "my_retentionPeriod", + * // "startTime": "my_startTime", + * // "updateTime": "my_updateTime" * // } * } * @@ -5126,58 +5266,61 @@ export namespace firestore_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + create( + params: Params$Resource$Projects$Databases$Changestreams$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + create( + params?: Params$Resource$Projects$Databases$Changestreams$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Databases$Changestreams$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + create( + params: Params$Resource$Projects$Databases$Changestreams$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Databases$Changestreams$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Databases$Collectiongroups$Fields$Get - | BodyResponseCallback + | Params$Resource$Projects$Databases$Changestreams$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Databases$Collectiongroups$Fields$Get; + {}) as Params$Resource$Projects$Databases$Changestreams$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Databases$Collectiongroups$Fields$Get; + params = {} as Params$Resource$Projects$Databases$Changestreams$Create; options = {}; } @@ -5190,29 +5333,34 @@ export namespace firestore_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/changeStreams').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`. + * Deletes a change stream. * @example * ```js * // Before running the sample: @@ -5244,24 +5392,16 @@ export namespace firestore_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await firestore.projects.databases.collectionGroups.fields.list({ - * // The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`. - * filter: 'placeholder-value', - * // The number of results to return. - * pageSize: 'placeholder-value', - * // A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results. - * pageToken: 'placeholder-value', - * // Required. A parent name of the form `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}` - * parent: - * 'projects/my-project/databases/my-database/collectionGroups/my-collectionGroup', + * const res = await firestore.projects.databases.changeStreams.delete({ + * // Optional. The etag of the change stream to delete. If this is not the current etag of the change stream, the deletion will fail. + * etag: 'placeholder-value', + * // Required. The name of the change stream to delete. Format is `projects/{project\}/databases/{database\}/changeStreams/{change_stream\}`. + * name: 'projects/my-project/databases/my-database/changeStreams/my-changeStream', * }); * console.log(res.data); * * // Example response - * // { - * // "fields": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -5276,62 +5416,52 @@ export namespace firestore_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + delete( + params: Params$Resource$Projects$Databases$Changestreams$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + delete( + params?: Params$Resource$Projects$Databases$Changestreams$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Databases$Changestreams$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Databases$Changestreams$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Databases$Changestreams$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Databases$Collectiongroups$Fields$List - | BodyResponseCallback + | Params$Resource$Projects$Databases$Changestreams$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback - | BodyResponseCallback + BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Databases$Collectiongroups$Fields$List; + {}) as Params$Resource$Projects$Databases$Changestreams$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Databases$Collectiongroups$Fields$List; + params = {} as Params$Resource$Projects$Databases$Changestreams$Delete; options = {}; } @@ -5344,34 +5474,29 @@ export namespace firestore_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/fields').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" \}`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id\}/databases/{database_id\}/collectionGroups/__default__/fields/x`. + * Gets information about a change stream. * @example * ```js * // Before running the sample: @@ -5403,12 +5528,679 @@ export namespace firestore_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await firestore.projects.databases.collectionGroups.fields.patch({ - * // Required. A field name of the form: `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/fields/{field_path\}` A field path can be a simple field name, e.g. `address` or a path to fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using `` ` `` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: `` `address.city` `` represents a field named `address.city`, not the map key `city` in the field `address`. `` `*` `` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id\}/databases/{database_id\}/collectionGroups/__default__/fields/x` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. - * name: 'projects/my-project/databases/my-database/collectionGroups/my-collectionGroup/fields/my-field', - * // A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. - * updateMask: 'placeholder-value', - * + * const res = await firestore.projects.databases.changeStreams.get({ + * // Required. The name of the change stream to retrieve. Format is `projects/{project\}/databases/{database\}/changeStreams/{change_stream\}`. + * name: 'projects/my-project/databases/my-database/changeStreams/my-changeStream', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "collectionGroupScope": {}, + * // "createTime": "my_createTime", + * // "databaseScope": {}, + * // "etag": "my_etag", + * // "name": "my_name", + * // "retentionPeriod": "my_retentionPeriod", + * // "startTime": "my_startTime", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Databases$Changestreams$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Databases$Changestreams$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Databases$Changestreams$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Databases$Changestreams$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Databases$Changestreams$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Changestreams$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Changestreams$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Changestreams$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.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 all change streams in a database. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firestore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firestore = google.firestore('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/datastore', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await firestore.projects.databases.changeStreams.list({ + * // Required. The parent database to list change streams from. Format is `projects/{project\}/databases/{database\}`. + * parent: 'projects/my-project/databases/my-database', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "changeStreams": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Databases$Changestreams$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Databases$Changestreams$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Databases$Changestreams$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Databases$Changestreams$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Databases$Changestreams$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Changestreams$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Changestreams$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Databases$Changestreams$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/changeStreams').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$Databases$Changestreams$Create extends StandardParameters { + /** + * Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value should be 4-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character must be a letter or a number. + */ + changeStreamId?: string; + /** + * Required. The parent database to create the change stream for. Format is `projects/{project\}/databases/{database\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirestoreAdminV1ChangeStream; + } + export interface Params$Resource$Projects$Databases$Changestreams$Delete extends StandardParameters { + /** + * Optional. The etag of the change stream to delete. If this is not the current etag of the change stream, the deletion will fail. + */ + etag?: string; + /** + * Required. The name of the change stream to delete. Format is `projects/{project\}/databases/{database\}/changeStreams/{change_stream\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Databases$Changestreams$Get extends StandardParameters { + /** + * Required. The name of the change stream to retrieve. Format is `projects/{project\}/databases/{database\}/changeStreams/{change_stream\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Databases$Changestreams$List extends StandardParameters { + /** + * Required. The parent database to list change streams from. Format is `projects/{project\}/databases/{database\}`. + */ + parent?: string; + } + + export class Resource$Projects$Databases$Collectiongroups { + context: APIRequestContext; + fields: Resource$Projects$Databases$Collectiongroups$Fields; + indexes: Resource$Projects$Databases$Collectiongroups$Indexes; + constructor(context: APIRequestContext) { + this.context = context; + this.fields = new Resource$Projects$Databases$Collectiongroups$Fields( + this.context + ); + this.indexes = new Resource$Projects$Databases$Collectiongroups$Indexes( + this.context + ); + } + } + + export class Resource$Projects$Databases$Collectiongroups$Fields { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the metadata and configuration for a Field. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firestore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firestore = google.firestore('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/datastore', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await firestore.projects.databases.collectionGroups.fields.get({ + * // Required. A name of the form `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/fields/{field_id\}` + * name: 'projects/my-project/databases/my-database/collectionGroups/my-collectionGroup/fields/my-field', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "indexConfig": {}, + * // "name": "my_name", + * // "ttlConfig": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Collectiongroups$Fields$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Collectiongroups$Fields$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Databases$Collectiongroups$Fields$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firestore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firestore = google.firestore('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/datastore', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await firestore.projects.databases.collectionGroups.fields.list({ + * // The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`. + * filter: 'placeholder-value', + * // The number of results to return. + * pageSize: 'placeholder-value', + * // A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results. + * pageToken: 'placeholder-value', + * // Required. A parent name of the form `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}` + * parent: + * 'projects/my-project/databases/my-database/collectionGroups/my-collectionGroup', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "fields": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Databases$Collectiongroups$Fields$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Databases$Collectiongroups$Fields$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Databases$Collectiongroups$Fields$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Databases$Collectiongroups$Fields$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firestore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/fields').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 field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" \}`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id\}/databases/{database_id\}/collectionGroups/__default__/fields/x`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firestore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firestore = google.firestore('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/datastore', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await firestore.projects.databases.collectionGroups.fields.patch({ + * // Required. A field name of the form: `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/fields/{field_path\}` A field path can be a simple field name, e.g. `address` or a path to fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using `` ` `` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: `` `address.city` `` represents a field named `address.city`, not the map key `city` in the field `address`. `` `*` `` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id\}/databases/{database_id\}/collectionGroups/__default__/fields/x` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. + * name: 'projects/my-project/databases/my-database/collectionGroups/my-collectionGroup/fields/my-field', + * // A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. + * updateMask: 'placeholder-value', + * * // Request body metadata * requestBody: { * // request body parameters @@ -6281,6 +7073,7 @@ export namespace firestore_v1 { * // "mask": {}, * // "newTransaction": {}, * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "transaction": "my_transaction" * // } * }, @@ -6436,6 +7229,7 @@ export namespace firestore_v1 { * // request body parameters * // { * // "labels": {}, + * // "requestOptions": {}, * // "writes": [] * // } * }, @@ -6585,7 +7379,8 @@ export namespace firestore_v1 { * requestBody: { * // request body parameters * // { - * // "options": {} + * // "options": {}, + * // "requestOptions": {} * // } * }, * }); @@ -6736,6 +7531,7 @@ export namespace firestore_v1 { * requestBody: { * // request body parameters * // { + * // "requestOptions": {}, * // "transaction": "my_transaction", * // "writes": [] * // } @@ -6887,6 +7683,8 @@ export namespace firestore_v1 { * 'mask.fieldPaths': 'placeholder-value', * // Required. The parent resource. For example: `projects/{project_id\}/databases/{database_id\}/documents` or `projects/{project_id\}/databases/{database_id\}/documents/chatrooms/{chatroom_id\}` * parent: 'projects/my-project/databases/my-database/documents/.*', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * * // Request body metadata * requestBody: { @@ -7045,6 +7843,8 @@ export namespace firestore_v1 { * 'currentDocument.updateTime': 'placeholder-value', * // Required. The resource name of the Document to delete. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. * name: 'projects/my-project/databases/my-database/documents/my-document/.*', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * }); * console.log(res.data); * @@ -7187,6 +7987,7 @@ export namespace firestore_v1 { * // "autoCommitTransaction": false, * // "newTransaction": {}, * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "structuredPipeline": {}, * // "transaction": "my_transaction" * // } @@ -7341,6 +8142,8 @@ export namespace firestore_v1 { * name: 'projects/my-project/databases/my-database/documents/my-document/.*', * // Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. * readTime: 'placeholder-value', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * // Reads the document in a transaction. * transaction: 'placeholder-value', * }); @@ -7497,6 +8300,8 @@ export namespace firestore_v1 { * readTime: 'placeholder-value', * // Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. * recursive: 'placeholder-value', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * // If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. * showMissing: 'placeholder-value', * // Perform the read as part of an already active transaction. @@ -7651,7 +8456,8 @@ export namespace firestore_v1 { * // { * // "pageSize": 0, * // "pageToken": "my_pageToken", - * // "readTime": "my_readTime" + * // "readTime": "my_readTime", + * // "requestOptions": {} * // } * }, * }); @@ -7813,6 +8619,8 @@ export namespace firestore_v1 { * readTime: 'placeholder-value', * // Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. * recursive: 'placeholder-value', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * // If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. * showMissing: 'placeholder-value', * // Perform the read as part of an already active transaction. @@ -7969,7 +8777,8 @@ export namespace firestore_v1 { * // { * // "addTarget": {}, * // "labels": {}, - * // "removeTarget": 0 + * // "removeTarget": 0, + * // "requestOptions": {} * // } * }, * }); @@ -8126,6 +8935,7 @@ export namespace firestore_v1 { * // "pageToken": "my_pageToken", * // "partitionCount": "my_partitionCount", * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "structuredQuery": {} * // } * }, @@ -8280,6 +9090,8 @@ export namespace firestore_v1 { * 'mask.fieldPaths': 'placeholder-value', * // The resource name of the document, for example `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. * name: 'projects/my-project/databases/my-database/documents/my-document/.*', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * // The list of field paths in the mask. See Document.fields for a field path syntax reference. * 'updateMask.fieldPaths': 'placeholder-value', * @@ -8437,6 +9249,7 @@ export namespace firestore_v1 { * requestBody: { * // request body parameters * // { + * // "requestOptions": {}, * // "transaction": "my_transaction" * // } * }, @@ -8586,6 +9399,7 @@ export namespace firestore_v1 { * // "explainOptions": {}, * // "newTransaction": {}, * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "structuredAggregationQuery": {}, * // "transaction": "my_transaction" * // } @@ -8747,6 +9561,7 @@ export namespace firestore_v1 { * // "explainOptions": {}, * // "newTransaction": {}, * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "structuredQuery": {}, * // "transaction": "my_transaction" * // } @@ -8902,6 +9717,7 @@ export namespace firestore_v1 { * // request body parameters * // { * // "labels": {}, + * // "requestOptions": {}, * // "streamId": "my_streamId", * // "streamToken": "my_streamToken", * // "writes": [] @@ -9076,6 +9892,10 @@ export namespace firestore_v1 { * Required. The parent resource. For example: `projects/{project_id\}/databases/{database_id\}/documents` or `projects/{project_id\}/databases/{database_id\}/documents/chatrooms/{chatroom_id\}` */ parent?: string; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * Request body metadata @@ -9095,6 +9915,10 @@ export namespace firestore_v1 { * Required. The resource name of the Document to delete. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. */ name?: string; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; } export interface Params$Resource$Projects$Databases$Documents$Executepipeline extends StandardParameters { /** @@ -9120,6 +9944,10 @@ export namespace firestore_v1 { * Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * Reads the document in a transaction. */ @@ -9158,6 +9986,10 @@ export namespace firestore_v1 { * Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. */ recursive?: boolean; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. */ @@ -9211,6 +10043,10 @@ export namespace firestore_v1 { * Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. */ recursive?: boolean; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. */ @@ -9259,6 +10095,10 @@ export namespace firestore_v1 { * The resource name of the document, for example `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. */ name?: string; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index 0d53068f131..6eee9cd981c 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -192,6 +192,10 @@ export namespace firestore_v1beta1 { * Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * Reads documents in a transaction. */ @@ -226,6 +230,10 @@ export namespace firestore_v1beta1 { * Labels associated with this batch write. */ labels?: {[key: string]: string} | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request. */ @@ -252,6 +260,10 @@ export namespace firestore_v1beta1 { * The options for the transaction. Defaults to a read-write transaction. */ options?: Schema$TransactionOptions; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; } /** * The response for Firestore.BeginTransaction. @@ -305,6 +317,10 @@ export namespace firestore_v1beta1 { * The request for Firestore.Commit. */ export interface Schema$CommitRequest { + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * If set, applies all writes in this transaction, and commits it. */ @@ -485,6 +501,10 @@ export namespace firestore_v1beta1 { * Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * A pipelined operation. */ @@ -495,7 +515,7 @@ export namespace firestore_v1beta1 { transaction?: string | null; } /** - * The response for Firestore.Execute. + * The response for Firestore.ExecutePipeline. */ export interface Schema$ExecutePipelineResponse { /** @@ -1036,7 +1056,20 @@ export namespace firestore_v1beta1 { /** * Metadata related to the update database operation. */ - export interface Schema$GoogleFirestoreAdminV1UpdateDatabaseMetadata {} + export interface Schema$GoogleFirestoreAdminV1UpdateDatabaseMetadata { + /** + * The time this operation completed. Will be unset if operation still in progress. + */ + endTime?: string | null; + /** + * The time this operation started. + */ + startTime?: string | null; + /** + * The state of the operation. + */ + state?: string | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1091,6 +1124,10 @@ export namespace firestore_v1beta1 { * Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; } /** * The response from Firestore.ListCollectionIds. @@ -1134,6 +1171,10 @@ export namespace firestore_v1beta1 { * The ID of a target to remove from this stream. */ removeTarget?: number | null; + /** + * Optional. The request options for the request. + */ + requestOptions?: Schema$RequestOptions; } /** * The response for Firestore.Listen. @@ -1202,6 +1243,10 @@ export namespace firestore_v1beta1 { * Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for the request. + */ + requestOptions?: Schema$RequestOptions; /** * A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. */ @@ -1295,10 +1340,23 @@ export namespace firestore_v1beta1 { */ retryTransaction?: string | null; } + /** + * Options for a server request. + */ + export interface Schema$RequestOptions { + /** + * Optional. The request tags for the request. + */ + requestTags?: string[] | null; + } /** * The request for Firestore.Rollback. */ export interface Schema$RollbackRequest { + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * Required. The transaction to roll back. */ @@ -1320,6 +1378,10 @@ export namespace firestore_v1beta1 { * Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for the request. + */ + requestOptions?: Schema$RequestOptions; /** * An aggregation query. */ @@ -1366,6 +1428,10 @@ export namespace firestore_v1beta1 { * Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string | null; + /** + * Optional. The request options for this request. + */ + requestOptions?: Schema$RequestOptions; /** * A structured query. */ @@ -1603,7 +1669,7 @@ export namespace firestore_v1beta1 { */ export interface Schema$Value { /** - * An array value. Cannot directly contain another array value, though can contain a map which contains another array. + * An array value. In Standard edition databases, an array value cannot directly contain another array value, though it can contain a map which contains another array. In Enterprise edition databases, an array value can contain another array value. */ arrayValue?: Schema$ArrayValue; /** @@ -1611,7 +1677,7 @@ export namespace firestore_v1beta1 { */ booleanValue?: boolean | null; /** - * A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + * A bytes value. In Standard edition databases: * The value must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits. */ bytesValue?: string | null; /** @@ -1651,7 +1717,7 @@ export namespace firestore_v1beta1 { */ referenceValue?: string | null; /** - * A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + * A string value. In Standard edition databases: * The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes of the UTF-8 representation are considered by queries. In Enterprise edition databases, there is no limit on the size of the value. However, it is still subject to document and index entry size limits. */ stringValue?: string | null; /** @@ -1700,6 +1766,10 @@ export namespace firestore_v1beta1 { * Labels associated with this write request. */ labels?: {[key: string]: string} | null; + /** + * Optional. The request options for the request. + */ + requestOptions?: Schema$RequestOptions; /** * The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. */ @@ -2154,6 +2224,7 @@ export namespace firestore_v1beta1 { * // "mask": {}, * // "newTransaction": {}, * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "transaction": "my_transaction" * // } * }, @@ -2309,6 +2380,7 @@ export namespace firestore_v1beta1 { * // request body parameters * // { * // "labels": {}, + * // "requestOptions": {}, * // "writes": [] * // } * }, @@ -2457,7 +2529,8 @@ export namespace firestore_v1beta1 { * requestBody: { * // request body parameters * // { - * // "options": {} + * // "options": {}, + * // "requestOptions": {} * // } * }, * }); @@ -2608,6 +2681,7 @@ export namespace firestore_v1beta1 { * requestBody: { * // request body parameters * // { + * // "requestOptions": {}, * // "transaction": "my_transaction", * // "writes": [] * // } @@ -2759,6 +2833,8 @@ export namespace firestore_v1beta1 { * 'mask.fieldPaths': 'placeholder-value', * // Required. The parent resource. For example: `projects/{project_id\}/databases/{database_id\}/documents` or `projects/{project_id\}/databases/{database_id\}/documents/chatrooms/{chatroom_id\}` * parent: 'projects/my-project/databases/my-database/documents/.*', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * * // Request body metadata * requestBody: { @@ -2917,6 +2993,8 @@ export namespace firestore_v1beta1 { * 'currentDocument.updateTime': 'placeholder-value', * // Required. The resource name of the Document to delete. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. * name: 'projects/my-project/databases/my-database/documents/my-document/.*', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * }); * console.log(res.data); * @@ -3059,6 +3137,7 @@ export namespace firestore_v1beta1 { * // "autoCommitTransaction": false, * // "newTransaction": {}, * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "structuredPipeline": {}, * // "transaction": "my_transaction" * // } @@ -3213,6 +3292,8 @@ export namespace firestore_v1beta1 { * name: 'projects/my-project/databases/my-database/documents/my-document/.*', * // Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. * readTime: 'placeholder-value', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * // Reads the document in a transaction. * transaction: 'placeholder-value', * }); @@ -3369,6 +3450,8 @@ export namespace firestore_v1beta1 { * readTime: 'placeholder-value', * // Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. * recursive: 'placeholder-value', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * // If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. * showMissing: 'placeholder-value', * // Perform the read as part of an already active transaction. @@ -3523,7 +3606,8 @@ export namespace firestore_v1beta1 { * // { * // "pageSize": 0, * // "pageToken": "my_pageToken", - * // "readTime": "my_readTime" + * // "readTime": "my_readTime", + * // "requestOptions": {} * // } * }, * }); @@ -3685,6 +3769,8 @@ export namespace firestore_v1beta1 { * readTime: 'placeholder-value', * // Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. * recursive: 'placeholder-value', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * // If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. * showMissing: 'placeholder-value', * // Perform the read as part of an already active transaction. @@ -3841,7 +3927,8 @@ export namespace firestore_v1beta1 { * // { * // "addTarget": {}, * // "labels": {}, - * // "removeTarget": 0 + * // "removeTarget": 0, + * // "requestOptions": {} * // } * }, * }); @@ -3998,6 +4085,7 @@ export namespace firestore_v1beta1 { * // "pageToken": "my_pageToken", * // "partitionCount": "my_partitionCount", * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "structuredQuery": {} * // } * }, @@ -4152,6 +4240,8 @@ export namespace firestore_v1beta1 { * 'mask.fieldPaths': 'placeholder-value', * // The resource name of the document, for example `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. * name: 'projects/my-project/databases/my-database/documents/my-document/.*', + * // Optional. The request tags for the request. + * 'requestOptions.requestTags': 'placeholder-value', * // The list of field paths in the mask. See Document.fields for a field path syntax reference. * 'updateMask.fieldPaths': 'placeholder-value', * @@ -4309,6 +4399,7 @@ export namespace firestore_v1beta1 { * requestBody: { * // request body parameters * // { + * // "requestOptions": {}, * // "transaction": "my_transaction" * // } * }, @@ -4458,6 +4549,7 @@ export namespace firestore_v1beta1 { * // "explainOptions": {}, * // "newTransaction": {}, * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "structuredAggregationQuery": {}, * // "transaction": "my_transaction" * // } @@ -4619,6 +4711,7 @@ export namespace firestore_v1beta1 { * // "explainOptions": {}, * // "newTransaction": {}, * // "readTime": "my_readTime", + * // "requestOptions": {}, * // "structuredQuery": {}, * // "transaction": "my_transaction" * // } @@ -4774,6 +4867,7 @@ export namespace firestore_v1beta1 { * // request body parameters * // { * // "labels": {}, + * // "requestOptions": {}, * // "streamId": "my_streamId", * // "streamToken": "my_streamToken", * // "writes": [] @@ -4948,6 +5042,10 @@ export namespace firestore_v1beta1 { * Required. The parent resource. For example: `projects/{project_id\}/databases/{database_id\}/documents` or `projects/{project_id\}/databases/{database_id\}/documents/chatrooms/{chatroom_id\}` */ parent?: string; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * Request body metadata @@ -4967,6 +5065,10 @@ export namespace firestore_v1beta1 { * Required. The resource name of the Document to delete. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. */ name?: string; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; } export interface Params$Resource$Projects$Databases$Documents$Executepipeline extends StandardParameters { /** @@ -4992,6 +5094,10 @@ export namespace firestore_v1beta1 { * Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. */ readTime?: string; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * Reads the document in a transaction. */ @@ -5030,6 +5136,10 @@ export namespace firestore_v1beta1 { * Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. */ recursive?: boolean; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. */ @@ -5083,6 +5193,10 @@ export namespace firestore_v1beta1 { * Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. */ recursive?: boolean; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. */ @@ -5131,6 +5245,10 @@ export namespace firestore_v1beta1 { * The resource name of the document, for example `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. */ name?: string; + /** + * Optional. The request tags for the request. + */ + 'requestOptions.requestTags'?: string[]; /** * The list of field paths in the mask. See Document.fields for a field path syntax reference. */ diff --git a/src/apis/firestore/v1beta2.ts b/src/apis/firestore/v1beta2.ts index 0c823e596db..dec8c427127 100644 --- a/src/apis/firestore/v1beta2.ts +++ b/src/apis/firestore/v1beta2.ts @@ -551,7 +551,20 @@ export namespace firestore_v1beta2 { /** * Metadata related to the update database operation. */ - export interface Schema$GoogleFirestoreAdminV1UpdateDatabaseMetadata {} + export interface Schema$GoogleFirestoreAdminV1UpdateDatabaseMetadata { + /** + * The time this operation completed. Will be unset if operation still in progress. + */ + endTime?: string | null; + /** + * The time this operation started. + */ + startTime?: string | null; + /** + * The state of the operation. + */ + state?: string | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ diff --git a/src/apis/games/v1.ts b/src/apis/games/v1.ts index 4db2024c937..8829666e989 100644 --- a/src/apis/games/v1.ts +++ b/src/apis/games/v1.ts @@ -117,9 +117,9 @@ export namespace games_v1 { achievements: Resource$Achievements; applications: Resource$Applications; events: Resource$Events; + gameStats: Resource$Gamestats; leaderboards: Resource$Leaderboards; metagame: Resource$Metagame; - playerGameEvents: Resource$Playergameevents; players: Resource$Players; recall: Resource$Recall; revisions: Resource$Revisions; @@ -140,9 +140,9 @@ export namespace games_v1 { this.achievements = new Resource$Achievements(this.context); this.applications = new Resource$Applications(this.context); this.events = new Resource$Events(this.context); + this.gameStats = new Resource$Gamestats(this.context); this.leaderboards = new Resource$Leaderboards(this.context); this.metagame = new Resource$Metagame(this.context); - this.playerGameEvents = new Resource$Playergameevents(this.context); this.players = new Resource$Players(this.context); this.recall = new Resource$Recall(this.context); this.revisions = new Resource$Revisions(this.context); @@ -4429,6 +4429,177 @@ export namespace games_v1 { requestBody?: Schema$EventRecordRequest; } + export class Resource$Gamestats { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Records a batch of player game events for a specific player. This method allows sending multiple events in a single request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/games.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const games = google.games('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/games'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await games.gameStats.batchRecordEvents({ + * // Required. The player ID of the player that performed the events. + * playerId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "droidGuardBlob": "my_droidGuardBlob", + * // "events": [], + * // "packageName": "my_packageName", + * // "requestTime": "my_requestTime", + * // "salt": "my_salt" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "failedRequests": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchRecordEvents( + params: Params$Resource$Gamestats$Batchrecordevents, + options: StreamMethodOptions + ): Promise>; + batchRecordEvents( + params?: Params$Resource$Gamestats$Batchrecordevents, + options?: MethodOptions + ): Promise>; + batchRecordEvents( + params: Params$Resource$Gamestats$Batchrecordevents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchRecordEvents( + params: Params$Resource$Gamestats$Batchrecordevents, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchRecordEvents( + params: Params$Resource$Gamestats$Batchrecordevents, + callback: BodyResponseCallback + ): void; + batchRecordEvents( + callback: BodyResponseCallback + ): void; + batchRecordEvents( + paramsOrCallback?: + | Params$Resource$Gamestats$Batchrecordevents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Gamestats$Batchrecordevents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Gamestats$Batchrecordevents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://games.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/games/v1/players/{playerId}/gameStats:batchRecordEvents' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['playerId'], + pathParams: ['playerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Gamestats$Batchrecordevents extends StandardParameters { + /** + * Required. The player ID of the player that performed the events. + */ + playerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchRecordEventsRequest; + } + export class Resource$Leaderboards { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -5066,177 +5237,6 @@ export namespace games_v1 { playerId?: string; } - export class Resource$Playergameevents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Records a batch of player game events for a specific player. This method allows sending multiple events in a single request. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/games.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const games = google.games('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/games'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await games.playerGameEvents.batchRecordEvents({ - * // Required. The player ID of the player that performed the events. - * playerId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "droidGuardBlob": "my_droidGuardBlob", - * // "events": [], - * // "packageName": "my_packageName", - * // "requestTime": "my_requestTime", - * // "salt": "my_salt" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "failedRequests": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - batchRecordEvents( - params: Params$Resource$Playergameevents$Batchrecordevents, - options: StreamMethodOptions - ): Promise>; - batchRecordEvents( - params?: Params$Resource$Playergameevents$Batchrecordevents, - options?: MethodOptions - ): Promise>; - batchRecordEvents( - params: Params$Resource$Playergameevents$Batchrecordevents, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchRecordEvents( - params: Params$Resource$Playergameevents$Batchrecordevents, - options: - MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchRecordEvents( - params: Params$Resource$Playergameevents$Batchrecordevents, - callback: BodyResponseCallback - ): void; - batchRecordEvents( - callback: BodyResponseCallback - ): void; - batchRecordEvents( - paramsOrCallback?: - | Params$Resource$Playergameevents$Batchrecordevents - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Playergameevents$Batchrecordevents; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Playergameevents$Batchrecordevents; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://games.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/games/v1/players/{playerId}/gameEvents:batchRecordEvents' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['playerId'], - pathParams: ['playerId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Playergameevents$Batchrecordevents extends StandardParameters { - /** - * Required. The player ID of the player that performed the events. - */ - playerId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BatchRecordEventsRequest; - } - export class Resource$Players { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index e555d3db012..fad8e8fd903 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -2572,6 +2572,15 @@ export namespace gkehub_v1 { * Request message for pausing a rollout. */ export interface Schema$PauseRolloutRequest {} + /** + * Configuration for per-stage soak duration overrides. + */ + export interface Schema$PerStageSoakDurationOverrides { + /** + * Required. A mapping of stage numbers to their respective desired soak durations. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. + */ + stageOverrides?: {[key: string]: 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/). */ @@ -2976,6 +2985,14 @@ export namespace gkehub_v1 { * Output only. etag of the Rollout Ex. abc1234 */ etag?: string | null; + /** + * Optional. If set to true, the rollout will ignore the disruption budgets of the clusters. + */ + ignoreClusterDisruptionBudgets?: boolean | null; + /** + * Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters. + */ + ignoreMaintenancePolicies?: boolean | null; /** * Output only. The intent of the rollout. */ @@ -3000,6 +3017,10 @@ export namespace gkehub_v1 { * Output only. The stages of the Rollout. */ stages?: Schema$RolloutStage[]; + /** + * Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. + */ + stageSoakDurationOverrides?: {[key: string]: string} | null; /** * Output only. State specifies various states of the Rollout. */ @@ -3485,6 +3506,26 @@ export namespace gkehub_v1 { * Optional. If set to true, any rollout already running on the first stage of the sequence will be cancelled to allow for the creation of the new rollout. */ force?: boolean | null; + /** + * Optional. If set to true, the rollout will ignore the disruption budgets of the clusters. + */ + ignoreClusterDisruptionBudgets?: boolean | null; + /** + * Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters. + */ + ignoreMaintenancePolicies?: boolean | null; + /** + * Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version. + */ + patchOnly?: boolean | null; + /** + * Optional. Overrides the soak duration for all stages of the rollout. + */ + soakDurationOverrideAllStages?: string | null; + /** + * Optional. Overrides the soak durations for specific stages of the rollout. + */ + soakDurationOverridePerStage?: Schema$PerStageSoakDurationOverrides; /** * Required. The type of upgrade. */ @@ -10688,11 +10729,14 @@ export namespace gkehub_v1 { * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "etag": "my_etag", + * // "ignoreClusterDisruptionBudgets": false, + * // "ignoreMaintenancePolicies": false, * // "intent": "my_intent", * // "labels": {}, * // "membershipStates": {}, * // "name": "my_name", * // "rolloutSequence": "my_rolloutSequence", + * // "stageSoakDurationOverrides": {}, * // "stages": [], * // "state": "my_state", * // "stateReason": "my_stateReason", @@ -12126,6 +12170,11 @@ export namespace gkehub_v1 { * // request body parameters * // { * // "force": false, + * // "ignoreClusterDisruptionBudgets": false, + * // "ignoreMaintenancePolicies": false, + * // "patchOnly": false, + * // "soakDurationOverrideAllStages": "my_soakDurationOverrideAllStages", + * // "soakDurationOverridePerStage": {}, * // "upgradeType": "my_upgradeType", * // "version": "my_version" * // } diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index 44c45823698..7ae72caf794 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -2801,6 +2801,15 @@ export namespace gkehub_v1alpha { * Request message for pausing a rollout. */ export interface Schema$PauseRolloutRequest {} + /** + * Configuration for per-stage soak duration overrides. + */ + export interface Schema$PerStageSoakDurationOverrides { + /** + * Required. A mapping of stage numbers to their respective desired soak durations. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. + */ + stageOverrides?: {[key: string]: 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/). */ @@ -3205,6 +3214,14 @@ export namespace gkehub_v1alpha { * Output only. etag of the Rollout Ex. abc1234 */ etag?: string | null; + /** + * Optional. If set to true, the rollout will ignore the disruption budgets of the clusters. + */ + ignoreClusterDisruptionBudgets?: boolean | null; + /** + * Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters. + */ + ignoreMaintenancePolicies?: boolean | null; /** * Output only. The intent of the rollout. */ @@ -3229,6 +3246,10 @@ export namespace gkehub_v1alpha { * Output only. The stages of the Rollout. */ stages?: Schema$RolloutStage[]; + /** + * Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. + */ + stageSoakDurationOverrides?: {[key: string]: string} | null; /** * Output only. State specifies various states of the Rollout. */ @@ -3790,6 +3811,26 @@ export namespace gkehub_v1alpha { * Optional. If set to true, any rollout already running on the first stage of the sequence will be cancelled to allow for the creation of the new rollout. */ force?: boolean | null; + /** + * Optional. If set to true, the rollout will ignore the disruption budgets of the clusters. + */ + ignoreClusterDisruptionBudgets?: boolean | null; + /** + * Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters. + */ + ignoreMaintenancePolicies?: boolean | null; + /** + * Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version. + */ + patchOnly?: boolean | null; + /** + * Optional. Overrides the soak duration for all stages of the rollout. + */ + soakDurationOverrideAllStages?: string | null; + /** + * Optional. Overrides the soak durations for specific stages of the rollout. + */ + soakDurationOverridePerStage?: Schema$PerStageSoakDurationOverrides; /** * Required. The type of upgrade. */ @@ -11719,11 +11760,14 @@ export namespace gkehub_v1alpha { * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "etag": "my_etag", + * // "ignoreClusterDisruptionBudgets": false, + * // "ignoreMaintenancePolicies": false, * // "intent": "my_intent", * // "labels": {}, * // "membershipStates": {}, * // "name": "my_name", * // "rolloutSequence": "my_rolloutSequence", + * // "stageSoakDurationOverrides": {}, * // "stages": [], * // "state": "my_state", * // "stateReason": "my_stateReason", @@ -13163,6 +13207,11 @@ export namespace gkehub_v1alpha { * // request body parameters * // { * // "force": false, + * // "ignoreClusterDisruptionBudgets": false, + * // "ignoreMaintenancePolicies": false, + * // "patchOnly": false, + * // "soakDurationOverrideAllStages": "my_soakDurationOverrideAllStages", + * // "soakDurationOverridePerStage": {}, * // "upgradeType": "my_upgradeType", * // "version": "my_version" * // } diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index 1ba3986f74d..fea9f7afa22 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -2649,6 +2649,15 @@ export namespace gkehub_v1beta { * Request message for pausing a rollout. */ export interface Schema$PauseRolloutRequest {} + /** + * Configuration for per-stage soak duration overrides. + */ + export interface Schema$PerStageSoakDurationOverrides { + /** + * Required. A mapping of stage numbers to their respective desired soak durations. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. + */ + stageOverrides?: {[key: string]: 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/). */ @@ -3053,6 +3062,14 @@ export namespace gkehub_v1beta { * Output only. etag of the Rollout Ex. abc1234 */ etag?: string | null; + /** + * Optional. If set to true, the rollout will ignore the disruption budgets of the clusters. + */ + ignoreClusterDisruptionBudgets?: boolean | null; + /** + * Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters. + */ + ignoreMaintenancePolicies?: boolean | null; /** * Output only. The intent of the rollout. */ @@ -3077,6 +3094,10 @@ export namespace gkehub_v1beta { * Output only. The stages of the Rollout. */ stages?: Schema$RolloutStage[]; + /** + * Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. + */ + stageSoakDurationOverrides?: {[key: string]: string} | null; /** * Output only. State specifies various states of the Rollout. */ @@ -3562,6 +3583,26 @@ export namespace gkehub_v1beta { * Optional. If set to true, any rollout already running on the first stage of the sequence will be cancelled to allow for the creation of the new rollout. */ force?: boolean | null; + /** + * Optional. If set to true, the rollout will ignore the disruption budgets of the clusters. + */ + ignoreClusterDisruptionBudgets?: boolean | null; + /** + * Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters. + */ + ignoreMaintenancePolicies?: boolean | null; + /** + * Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version. + */ + patchOnly?: boolean | null; + /** + * Optional. Overrides the soak duration for all stages of the rollout. + */ + soakDurationOverrideAllStages?: string | null; + /** + * Optional. Overrides the soak durations for specific stages of the rollout. + */ + soakDurationOverridePerStage?: Schema$PerStageSoakDurationOverrides; /** * Required. The type of upgrade. */ @@ -10771,11 +10812,14 @@ export namespace gkehub_v1beta { * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "etag": "my_etag", + * // "ignoreClusterDisruptionBudgets": false, + * // "ignoreMaintenancePolicies": false, * // "intent": "my_intent", * // "labels": {}, * // "membershipStates": {}, * // "name": "my_name", * // "rolloutSequence": "my_rolloutSequence", + * // "stageSoakDurationOverrides": {}, * // "stages": [], * // "state": "my_state", * // "stateReason": "my_stateReason", @@ -12215,6 +12259,11 @@ export namespace gkehub_v1beta { * // request body parameters * // { * // "force": false, + * // "ignoreClusterDisruptionBudgets": false, + * // "ignoreMaintenancePolicies": false, + * // "patchOnly": false, + * // "soakDurationOverrideAllStages": "my_soakDurationOverrideAllStages", + * // "soakDurationOverridePerStage": {}, * // "upgradeType": "my_upgradeType", * // "version": "my_version" * // } diff --git a/src/apis/health/v4.ts b/src/apis/health/v4.ts index f6deab9b6bd..55fd8f7d78f 100644 --- a/src/apis/health/v4.ts +++ b/src/apis/health/v4.ts @@ -5872,7 +5872,6 @@ export namespace health_v4 { * scopes: [ * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly', - * 'https://www.googleapis.com/auth/googlehealth.location.writeonly', * 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly', * 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly', @@ -6029,7 +6028,6 @@ export namespace health_v4 { * scopes: [ * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly', - * 'https://www.googleapis.com/auth/googlehealth.location.writeonly', * 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly', * 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly', @@ -6228,9 +6226,16 @@ export namespace health_v4 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', + * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly', * 'https://www.googleapis.com/auth/googlehealth.location.readonly', + * 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly', + * 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly', + * 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly', + * 'https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly', * 'https://www.googleapis.com/auth/googlehealth.sleep.readonly', + * 'https://www.googleapis.com/auth/googlehealth.sleep.writeonly', * ], * }); * @@ -6715,9 +6720,16 @@ export namespace health_v4 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', + * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly', * 'https://www.googleapis.com/auth/googlehealth.location.readonly', + * 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly', + * 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly', + * 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly', + * 'https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly', * 'https://www.googleapis.com/auth/googlehealth.sleep.readonly', + * 'https://www.googleapis.com/auth/googlehealth.sleep.writeonly', * ], * }); * @@ -6866,7 +6878,6 @@ export namespace health_v4 { * scopes: [ * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly', - * 'https://www.googleapis.com/auth/googlehealth.location.writeonly', * 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly', * 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly', @@ -7066,7 +7077,6 @@ export namespace health_v4 { * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly', * 'https://www.googleapis.com/auth/googlehealth.location.readonly', - * 'https://www.googleapis.com/auth/googlehealth.location.writeonly', * 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly', * 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly', @@ -7225,9 +7235,16 @@ export namespace health_v4 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly', + * 'https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly', * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly', + * 'https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly', * 'https://www.googleapis.com/auth/googlehealth.location.readonly', + * 'https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly', + * 'https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly', + * 'https://www.googleapis.com/auth/googlehealth.nutrition.writeonly', + * 'https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly', * 'https://www.googleapis.com/auth/googlehealth.sleep.readonly', + * 'https://www.googleapis.com/auth/googlehealth.sleep.writeonly', * ], * }); * diff --git a/src/apis/kmsinventory/v1.ts b/src/apis/kmsinventory/v1.ts index 2eb3f243b5e..70f96560ef7 100644 --- a/src/apis/kmsinventory/v1.ts +++ b/src/apis/kmsinventory/v1.ts @@ -369,7 +369,7 @@ export namespace kmsinventory_v1 { */ state?: string | null; /** - * Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. + * Optional. Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. */ trustedWrappingEnabled?: boolean | null; } diff --git a/src/apis/merchantapi/notifications_v1.ts b/src/apis/merchantapi/notifications_v1.ts index d24c3d9291a..2b5fe8d463a 100644 --- a/src/apis/merchantapi/notifications_v1.ts +++ b/src/apis/merchantapi/notifications_v1.ts @@ -709,9 +709,9 @@ export namespace merchantapi_notifications_v1 { * * // Do the magic * const res = await merchantapi.accounts.notificationsubscriptions.list({ - * // The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. + * // Optional. The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. * pageSize: 'placeholder-value', - * // Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. + * // Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. * pageToken: 'placeholder-value', * // Required. The merchant account who owns the notification subscriptions. Format: `accounts/{account\}` * parent: 'accounts/my-account', @@ -1013,11 +1013,11 @@ export namespace merchantapi_notifications_v1 { } export interface Params$Resource$Accounts$Notificationsubscriptions$List extends StandardParameters { /** - * The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. + * Optional. The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. */ pageSize?: number; /** - * Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. + * Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. */ pageToken?: string; /** diff --git a/src/apis/merchantapi/notifications_v1beta.ts b/src/apis/merchantapi/notifications_v1beta.ts index 24321f67183..3a034b480fc 100644 --- a/src/apis/merchantapi/notifications_v1beta.ts +++ b/src/apis/merchantapi/notifications_v1beta.ts @@ -710,9 +710,9 @@ export namespace merchantapi_notifications_v1beta { * * // Do the magic * const res = await merchantapi.accounts.notificationsubscriptions.list({ - * // The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. + * // Optional. The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. * pageSize: 'placeholder-value', - * // Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. + * // Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. * pageToken: 'placeholder-value', * // Required. The merchant account who owns the notification subscriptions. Format: `accounts/{account\}` * parent: 'accounts/my-account', @@ -1015,11 +1015,11 @@ export namespace merchantapi_notifications_v1beta { } export interface Params$Resource$Accounts$Notificationsubscriptions$List extends StandardParameters { /** - * The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. + * Optional. The maximum number of notification subscriptions to return in a page. The default value for `page_size` is 100. The maximum value is `200`. Values above `200` will be coerced to `200`. */ pageSize?: number; /** - * Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. + * Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. */ pageToken?: string; /** diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index 22b21ba728d..b39e2c078e9 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -2343,6 +2343,10 @@ export namespace networkmanagement_v1 { * Display information of a Storage Bucket. Used only for return traces. */ storageBucket?: Schema$StorageBucketInfo; + /** + * Display information of a step that is redacted due to missing permissions. + */ + viewerPermissionMissingInfo?: Schema$ViewerPermissionMissingInfo; /** * Display information of a VPC connector. */ @@ -2400,6 +2404,15 @@ export namespace networkmanagement_v1 { */ steps?: Schema$Step[]; } + /** + * For display only. Metadata associated with a step that was redacted due to missing permissions. + */ + export interface Schema$ViewerPermissionMissingInfo { + /** + * Types of the resources that the user does not have permission to view. + */ + resourceTypes?: string[] | null; + } /** * For display only. Metadata associated with a VPC connector. */ diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index 1c479a0a6af..787d049d441 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -1981,6 +1981,10 @@ export namespace networkmanagement_v1beta1 { * Display information of a Storage Bucket. Used only for return traces. */ storageBucket?: Schema$StorageBucketInfo; + /** + * Display information of a step that is redacted due to missing permissions. + */ + viewerPermissionMissingInfo?: Schema$ViewerPermissionMissingInfo; /** * Display information of a VPC connector. */ @@ -2038,6 +2042,15 @@ export namespace networkmanagement_v1beta1 { */ steps?: Schema$Step[]; } + /** + * For display only. Metadata associated with a step that was redacted due to missing permissions. + */ + export interface Schema$ViewerPermissionMissingInfo { + /** + * Types of the resources that the user does not have permission to view. + */ + resourceTypes?: string[] | null; + } /** * For display only. Metadata associated with a VPC connector. */ diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index 0af1051b79d..e9251e89aaf 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -686,7 +686,7 @@ export namespace networkservices_v1 { */ paths?: Schema$ExtensionBindingMatchConditionStringMatch[]; /** - * Optional. A list of non-empty strings whose value is matched against the resource value. If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. + * Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. */ resources?: Schema$ExtensionBindingMatchConditionStringMatch[]; } @@ -704,7 +704,7 @@ export namespace networkservices_v1 { */ export interface Schema$ExtensionBindingTarget { /** - * Optional. The reference to the target resource, to which this binding should attach. Exactly one of `resources` or `scope` must be set. For Agent Gateway, this would be the full resource name, in the format: `projects/{project\}/locations/{location\}/agentGateways/{agent_gateway\}`. For AI App, this would be the full resource name, in the format: `projects/{project\}/locations/{location\}/applications/{application\}`. + * Optional. The reference to the target resource, to which this binding should attach. Exactly one of `resources` or `scope` must be set. */ resources?: string[] | null; /** @@ -2413,7 +2413,7 @@ export namespace networkservices_v1 { */ extensionSettings?: Schema$ProducerExtensionExtensionSettings; /** - * Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements]((https://cloud.google.com/compute/docs/labeling-resources#requirements). + * Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). */ labels?: {[key: string]: string} | null; /** diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index 7793c3fb366..cb42f85f4f1 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -600,7 +600,7 @@ export namespace networkservices_v1beta1 { */ paths?: Schema$ExtensionBindingMatchConditionStringMatch[]; /** - * Optional. A list of non-empty strings whose value is matched against the resource value. If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. + * Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. */ resources?: Schema$ExtensionBindingMatchConditionStringMatch[]; } @@ -618,7 +618,7 @@ export namespace networkservices_v1beta1 { */ export interface Schema$ExtensionBindingTarget { /** - * Optional. The reference to the target resource, to which this binding should attach. Exactly one of `resources` or `scope` must be set. For Agent Gateway, this would be the full resource name, in the format: `projects/{project\}/locations/{location\}/agentGateways/{agent_gateway\}`. For AI App, this would be the full resource name, in the format: `projects/{project\}/locations/{location\}/applications/{application\}`. + * Optional. The reference to the target resource, to which this binding should attach. Exactly one of `resources` or `scope` must be set. */ resources?: string[] | null; /** @@ -2236,7 +2236,7 @@ export namespace networkservices_v1beta1 { */ extensionSettings?: Schema$ProducerExtensionExtensionSettings; /** - * Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements]((https://cloud.google.com/compute/docs/labeling-resources#requirements). + * Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). */ labels?: {[key: string]: string} | null; /** diff --git a/src/apis/notebooks/v1.ts b/src/apis/notebooks/v1.ts index d799439220d..da83725f9e0 100644 --- a/src/apis/notebooks/v1.ts +++ b/src/apis/notebooks/v1.ts @@ -1814,7 +1814,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -1951,7 +1954,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2134,7 +2140,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2290,7 +2299,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2427,7 +2439,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2567,7 +2582,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2760,7 +2778,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2918,7 +2939,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3055,7 +3079,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3196,7 +3223,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3401,7 +3431,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3588,7 +3621,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3725,7 +3761,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3874,7 +3913,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4044,7 +4086,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4185,7 +4230,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4327,7 +4375,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4477,7 +4528,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4625,7 +4679,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4773,7 +4830,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4921,7 +4981,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5067,7 +5130,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5216,7 +5282,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5359,7 +5428,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5507,7 +5579,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5657,7 +5732,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5804,7 +5882,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5952,7 +6033,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -6101,7 +6185,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -6244,7 +6331,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -6387,7 +6477,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -6536,7 +6629,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -6685,7 +6781,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -6841,7 +6940,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -6993,7 +7095,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -7141,7 +7246,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -7583,7 +7691,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -7720,7 +7831,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -7851,7 +7965,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -7988,7 +8105,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -8189,7 +8309,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -8352,7 +8475,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -8491,7 +8617,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -8640,7 +8769,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -8784,7 +8916,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -8924,7 +9059,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9072,7 +9210,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9224,7 +9365,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9384,7 +9528,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9542,7 +9689,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9691,7 +9841,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9836,7 +9989,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9982,7 +10138,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -10127,7 +10286,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -10272,7 +10434,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -10419,7 +10584,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -10568,7 +10736,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -10931,7 +11102,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -11090,7 +11264,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -11227,7 +11404,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -11369,7 +11549,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -11517,7 +11700,10 @@ export namespace notebooks_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index 51c35b1999c..4b38065a0b2 100644 --- a/src/apis/notebooks/v2.ts +++ b/src/apis/notebooks/v2.ts @@ -1034,6 +1034,10 @@ export namespace notebooks_v2 { * Optional. Use this VM image family to find the image; the newest image in this family will be used. */ family?: string | null; + /** + * Output only. A human-readable description of the image running on the instance (for example, "Debian 11, Python 3.10"), derived at read time from the image release configuration (the source of truth). Set to "Custom" for unrecognized boot-disk images. + */ + imageDescription?: string | null; /** * Optional. Use VM image name to find the image. */ @@ -1087,7 +1091,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -1224,7 +1231,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -1407,7 +1417,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -1558,7 +1571,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -1709,7 +1725,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -1880,7 +1899,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2019,7 +2041,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2168,7 +2193,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2321,7 +2349,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2473,7 +2504,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2612,7 +2646,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2753,7 +2790,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -2901,7 +2941,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3069,7 +3112,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3219,7 +3265,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3362,7 +3411,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3512,7 +3564,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3660,7 +3715,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3809,7 +3867,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -3956,7 +4017,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4099,7 +4163,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4242,7 +4309,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4391,7 +4461,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4539,7 +4612,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -4948,7 +5024,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5085,7 +5164,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5216,7 +5298,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -5353,7 +5438,10 @@ export namespace notebooks_v2 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/notebooks', + * ], * }); * * // Acquire an auth client, and bind it to all future calls diff --git a/src/apis/observability/v1.ts b/src/apis/observability/v1.ts index 924ba0add33..5f41304fadd 100644 --- a/src/apis/observability/v1.ts +++ b/src/apis/observability/v1.ts @@ -3698,6 +3698,164 @@ export namespace observability_v1 { ); } + /** + * Create a new bucket. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/observability.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const observability = google.observability('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await observability.projects.locations.buckets.create({ + * // Required. Id of the bucket to create. + * bucketId: 'placeholder-value', + * // Required. Name of the project and location for the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION] + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cmekSettings": {}, + * // "createTime": "my_createTime", + * // "deleteTime": "my_deleteTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "purgeTime": "my_purgeTime", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Buckets$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Buckets$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Buckets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Buckets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Buckets$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/buckets').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 bucket resource. * @example @@ -3983,8 +4141,178 @@ export namespace observability_v1 { return createAPIRequest(parameters); } } + + /** + * Update a bucket. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/observability.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const observability = google.observability('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await observability.projects.locations.buckets.patch({ + * // Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID] + * name: 'projects/my-project/locations/my-location/buckets/my-bucket', + * // Optional. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cmekSettings": {}, + * // "createTime": "my_createTime", + * // "deleteTime": "my_deleteTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "purgeTime": "my_purgeTime", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Buckets$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Buckets$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Buckets$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Buckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Buckets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://observability.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$Buckets$Create extends StandardParameters { + /** + * Required. Id of the bucket to create. + */ + bucketId?: string; + /** + * Required. Name of the project and location for the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION] + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Bucket; + } export interface Params$Resource$Projects$Locations$Buckets$Get extends StandardParameters { /** * Required. Name of the bucket to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID] @@ -4009,6 +4337,21 @@ export namespace observability_v1 { */ showDeleted?: boolean; } + export interface Params$Resource$Projects$Locations$Buckets$Patch extends StandardParameters { + /** + * Identifier. Name of the bucket. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID] + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Bucket; + } export class Resource$Projects$Locations$Buckets$Datasets { context: APIRequestContext; diff --git a/src/apis/paymentsresellersubscription/v1.ts b/src/apis/paymentsresellersubscription/v1.ts index a73443eef2f..f79502ada73 100644 --- a/src/apis/paymentsresellersubscription/v1.ts +++ b/src/apis/paymentsresellersubscription/v1.ts @@ -839,6 +839,10 @@ export namespace paymentsresellersubscription_v1 { * Describes the details of the migrated subscription. */ export interface Schema$SubscriptionMigrationDetails { + /** + * Output only. The creation time of the migrated subscription in the legacy system. + */ + legacyCreationTime?: string | null; /** * Output only. The migrated subscription id in the legacy system. */ diff --git a/src/apis/retail/README.md b/src/apis/retail/README.md index 5d0ccb22862..a5a95847599 100644 --- a/src/apis/retail/README.md +++ b/src/apis/retail/README.md @@ -2,7 +2,7 @@ # retail -> Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. +> The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. ## Support status **Note**: Google provides multiple libraries for this service. This library is in diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index 3ac185f2f43..2a89bdafc81 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -100,9 +100,9 @@ export namespace retail_v2 { } /** - * Vertex AI Search for commerce API + * AI Commerce Search API * - * Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. + * The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. * * @example * ```js diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index c25746cb8a4..471fb6e57cf 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -100,9 +100,9 @@ export namespace retail_v2alpha { } /** - * Vertex AI Search for commerce API + * AI Commerce Search API * - * Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. + * The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. * * @example * ```js diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 25e09d55ba1..73c6eb19ef7 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -100,9 +100,9 @@ export namespace retail_v2beta { } /** - * Vertex AI Search for commerce API + * AI Commerce Search API * - * Vertex AI Search for commerce API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. + * The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. * * @example * ```js diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 778e3d69466..189e8b31f33 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -632,6 +632,10 @@ export namespace run_v1 { * ExecutionSpec describes how the execution will look. */ export interface Schema$ExecutionSpec { + /** + * Optional. If true, the system will start the execution within the next 12 hours depending on available capacity. + */ + delayExecution?: boolean | null; /** * Optional. Specifies the maximum desired number of tasks the execution should run at given time. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed, i.e. when the work left to do is less than max parallelism. */ @@ -1321,6 +1325,10 @@ export namespace run_v1 { * Required. Where should the files be placed on the worker. */ destPath?: string | null; + /** + * Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags. + */ + fetchTags?: boolean | null; /** * Optional. True if submodules should be fetched too (default false). */ @@ -2524,7 +2532,7 @@ export namespace run_v1 { */ export interface Schema$ObjectMeta { /** - * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. + * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision . * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution, Instance. * `run.googleapis.com/container-dependencies`: Revision, Instance . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution, Instance. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution, Instance. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution, Instance. */ annotations?: {[key: string]: string} | null; /** @@ -2592,6 +2600,10 @@ export namespace run_v1 { * Per container override specification. */ containerOverrides?: Schema$ContainerOverride[]; + /** + * Optional. If true, the system will start the execution within the next 12 hours depending on available capacity. + */ + delayExecution?: boolean | null; /** * The desired number of tasks the execution should run. Will replace existing task_count value. */ diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 2bf3ccfe44f..99dfa7f756d 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -637,6 +637,10 @@ export namespace run_v2 { * Optional. Arbitrary version identifier for the API client. */ clientVersion?: string | null; + /** + * Optional. If true, the system will start the execution within the next 12 hours depending on available capacity. + */ + delayExecution?: boolean | null; /** * Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate. */ @@ -1242,6 +1246,10 @@ export namespace run_v2 { * Per container override specification. */ containerOverrides?: Schema$GoogleCloudRunV2ContainerOverride[]; + /** + * Optional. If true, the system will start the execution within the next 12 hours depending on available capacity. + */ + delayExecution?: boolean | null; /** * Optional. The desired number of tasks the execution should run. Will replace existing task_count value. */ @@ -1668,6 +1676,10 @@ export namespace run_v2 { * User-provided description of the Service. This field currently has a 512-character limit. */ description?: string | null; + /** + * Optional. Immutable. Indicates whether the Service has durable execution enabled. This field is immutable once the Service is created. + */ + durableExecution?: boolean | null; /** * Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. */ @@ -3057,6 +3069,10 @@ export namespace run_v2 { * Required. Where should the files be placed on the worker. */ destPath?: string | null; + /** + * Optional. True if remote tags should be fetched too (default false). Note: when depth is 1 (default), git fetch only retrieves tags pointing to commits within the shallow boundary. Set depth to -1 to fetch all historical tags. + */ + fetchTags?: boolean | null; /** * Optional. True if submodules should be fetched too (default false). */ @@ -9979,6 +9995,7 @@ export namespace run_v2 { * // "defaultUriDisabled": false, * // "deleteTime": "my_deleteTime", * // "description": "my_description", + * // "durableExecution": false, * // "etag": "my_etag", * // "expireTime": "my_expireTime", * // "generation": "my_generation", @@ -10321,6 +10338,7 @@ export namespace run_v2 { * // "defaultUriDisabled": false, * // "deleteTime": "my_deleteTime", * // "description": "my_description", + * // "durableExecution": false, * // "etag": "my_etag", * // "expireTime": "my_expireTime", * // "generation": "my_generation", @@ -10812,6 +10830,7 @@ export namespace run_v2 { * // "defaultUriDisabled": false, * // "deleteTime": "my_deleteTime", * // "description": "my_description", + * // "durableExecution": false, * // "etag": "my_etag", * // "expireTime": "my_expireTime", * // "generation": "my_generation", diff --git a/src/apis/saasservicemgmt/v1beta1.ts b/src/apis/saasservicemgmt/v1beta1.ts index 9130de6886e..cd0182c064f 100644 --- a/src/apis/saasservicemgmt/v1beta1.ts +++ b/src/apis/saasservicemgmt/v1beta1.ts @@ -176,11 +176,11 @@ export namespace saasservicemgmt_v1beta1 { */ export interface Schema$AppParams { /** - * Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name + * Optional. Grouping used to construct the name of the AppHub Application. Multiple UnitKinds can specify the same group to use the same Application across their respective units. Corresponds to the app_boundary_id in the ADC composite ApplicationTemplate. Defaults to UnitKind.name */ group?: string | null; /** - * Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL. + * Optional. Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL. */ scope?: Schema$Scope; } @@ -214,7 +214,7 @@ export namespace saasservicemgmt_v1beta1 { */ compositeRef?: Schema$CompositeRef; /** - * Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. + * Optional. Revision of the component. If the component does not have a revision, this field will be explicitly set to the revision of the composite ApplicationTemplate. */ revision?: string | null; } @@ -227,7 +227,7 @@ export namespace saasservicemgmt_v1beta1 { */ applicationTemplate?: string | null; /** - * Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. + * Optional. Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. */ revision?: string | null; /** @@ -442,6 +442,15 @@ export namespace saasservicemgmt_v1beta1 { */ valueType?: string | null; } + /** + * Wrapper for a list of flags. + */ + export interface Schema$FlagNameList { + /** + * Required. Flags to be rolled out. + */ + flags?: string[] | null; + } /** * A collection of FlagRevisions. */ @@ -470,6 +479,10 @@ export namespace saasservicemgmt_v1beta1 { * Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written. */ etag?: string | null; + /** + * Optional. Immutable. Specifies the release consisting of a list of flags. + */ + flagNamesRelease?: Schema$FlagNameList; /** * Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions. */ @@ -1658,7 +1671,7 @@ export namespace saasservicemgmt_v1beta1 { */ applicationTemplateComponent?: Schema$ComponentRef; /** - * AppParams contains the parameters for creating an AppHub Application. + * Optional. AppParams contains the parameters for creating an AppHub Application. */ appParams?: Schema$AppParams; /** @@ -3241,6 +3254,7 @@ export namespace saasservicemgmt_v1beta1 { * // "createTime": "my_createTime", * // "effectiveFlagRevisions": [], * // "etag": "my_etag", + * // "flagNamesRelease": {}, * // "flagRevisions": [], * // "flagRevisionsRelease": {}, * // "flagSets": [], @@ -3264,6 +3278,7 @@ export namespace saasservicemgmt_v1beta1 { * // "createTime": "my_createTime", * // "effectiveFlagRevisions": [], * // "etag": "my_etag", + * // "flagNamesRelease": {}, * // "flagRevisions": [], * // "flagRevisionsRelease": {}, * // "flagSets": [], @@ -3562,6 +3577,7 @@ export namespace saasservicemgmt_v1beta1 { * // "createTime": "my_createTime", * // "effectiveFlagRevisions": [], * // "etag": "my_etag", + * // "flagNamesRelease": {}, * // "flagRevisions": [], * // "flagRevisionsRelease": {}, * // "flagSets": [], @@ -3874,6 +3890,7 @@ export namespace saasservicemgmt_v1beta1 { * // "createTime": "my_createTime", * // "effectiveFlagRevisions": [], * // "etag": "my_etag", + * // "flagNamesRelease": {}, * // "flagRevisions": [], * // "flagRevisionsRelease": {}, * // "flagSets": [], @@ -3897,6 +3914,7 @@ export namespace saasservicemgmt_v1beta1 { * // "createTime": "my_createTime", * // "effectiveFlagRevisions": [], * // "etag": "my_etag", + * // "flagNamesRelease": {}, * // "flagRevisions": [], * // "flagRevisionsRelease": {}, * // "flagSets": [], diff --git a/src/apis/searchads360/v23.ts b/src/apis/searchads360/v23.ts index 6a2b47a5240..fbde90c833b 100644 --- a/src/apis/searchads360/v23.ts +++ b/src/apis/searchads360/v23.ts @@ -26126,6 +26126,10 @@ export namespace searchads360_v23 { * A campaign draft mutate operation. */ campaignDraftOperation?: Schema$GoogleAdsSearchads360V23Services__CampaignDraftOperation; + /** + * A campaign goal config mutate operation. + */ + campaignGoalConfigOperation?: Schema$GoogleAdsSearchads360V23Services__CampaignGoalConfigOperation; /** * A campaign group mutate operation. */ @@ -26383,6 +26387,10 @@ export namespace searchads360_v23 { * The result for the campaign draft mutate. */ campaignDraftResult?: Schema$GoogleAdsSearchads360V23Services__MutateCampaignDraftResult; + /** + * The result for the campaign goal config mutate. + */ + campaignGoalConfigResult?: Schema$GoogleAdsSearchads360V23Services__MutateCampaignGoalConfigResult; /** * The result for the campaign group mutate. */ diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 8bb2c59ae9f..ea6175b48b9 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -267,6 +267,19 @@ export namespace servicecontrol_v1 { */ status?: Schema$Status; } + /** + * A composite unique identifier for a PAM Grant which is {Org/Folder/Project identifier, grant Unique Identifier\} tuple. + */ + export interface Schema$AuditPamBindingId { + /** + * Output only. GCP Project/Folder/Organization identifier to which the PAM entitlement/grant is bound to. Container will be in the following form: projects/$project_num or folders/$folder_num or organizations/$org + */ + container?: string | null; + /** + * Output only. Represents the unique identifier for the PAM grant. Full_resource_name_pattern for PAM Grant is: //privilegedaccessmanager.googleapis.com/ (projects|folders|organizations)/$0/locations/$1/entitlements/$2/ grants/$3 where $3 is the grant_uuid. + */ + grantUuid?: string | null; + } /** * This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards. */ @@ -357,6 +370,10 @@ export namespace servicecontrol_v1 { * The type of the permission that was checked. For data access audit logs this corresponds with the permission type that must be enabled in the project/folder/organization IAM policy in order for the log to be written. */ permissionType?: string | null; + /** + * Output only. Metadata about the Privileged Access Manager (PAM) backed authorization decisions. This field is populated if the access is granted via an IAM policy with a binding which is managed by Privileged Access Manager. + */ + privilegedAccessManagerMetadata?: Schema$PrivilegedAccessManagerMetadata; /** * The resource being accessed, as a REST-style or cloud resource string. For example: bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID or projects/PROJECTID/datasets/DATASETID */ @@ -949,6 +966,19 @@ export namespace servicecontrol_v1 { * Indicates the orgpolicy violations for this resource. */ orgPolicyViolationInfo?: Schema$OrgPolicyViolationInfo; + /** + * Indicates the regional access boundary policy violations for this resource. + */ + rabPolicyViolationInfo?: Schema$RabPolicyViolationInfo; + } + /** + * Metadata about the Privileged Access Manager (PAM) backed authorization decisions. + */ + export interface Schema$PrivilegedAccessManagerMetadata { + /** + * Output only. If PAM is managing the elevated access, AuditPamBindingId is written to an Identity and Access Management (IAM) policy, which specifies access controls for resources. If the access is granted via an IAM policy with a binding which is managed by Privileged Access Manager, PrivilegedAccessManagerMetadata will contain the AuditPamBindingId. + */ + pamBindingIds?: Schema$AuditPamBindingId[]; } /** * Represents error information for QuotaOperation. @@ -1030,6 +1060,19 @@ export namespace servicecontrol_v1 { */ quotaMode?: string | null; } + /** + * Represents Regional Access Boundary (RAB) Policy Violation information. + */ + export interface Schema$RabPolicyViolationInfo { + /** + * Optional. Error message detailing what triggered the violation. The error message content originates from the authz library e.g., google3/cloud/security/iam/cap/deny_explanation/internal/make_error_msg.cc. This will be the same (canonical) error message provided by the http error code. + */ + errorMessage?: string | null; + /** + * Optional. The list of target locations of the resource. + */ + resourceLocations?: string[] | null; + } /** * Represents the processing error of one Operation in the request. */ diff --git a/src/apis/servicecontrol/v2.ts b/src/apis/servicecontrol/v2.ts index 4f39ee9f1d3..168c57e5b53 100644 --- a/src/apis/servicecontrol/v2.ts +++ b/src/apis/servicecontrol/v2.ts @@ -251,6 +251,19 @@ export namespace servicecontrol_v2 { */ status?: Schema$Status; } + /** + * A composite unique identifier for a PAM Grant which is {Org/Folder/Project identifier, grant Unique Identifier\} tuple. + */ + export interface Schema$AuditPamBindingId { + /** + * Output only. GCP Project/Folder/Organization identifier to which the PAM entitlement/grant is bound to. Container will be in the following form: projects/$project_num or folders/$folder_num or organizations/$org + */ + container?: string | null; + /** + * Output only. Represents the unique identifier for the PAM grant. Full_resource_name_pattern for PAM Grant is: //privilegedaccessmanager.googleapis.com/ (projects|folders|organizations)/$0/locations/$1/entitlements/$2/ grants/$3 where $3 is the grant_uuid. + */ + grantUuid?: string | null; + } /** * This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards. */ @@ -341,6 +354,10 @@ export namespace servicecontrol_v2 { * The type of the permission that was checked. For data access audit logs this corresponds with the permission type that must be enabled in the project/folder/organization IAM policy in order for the log to be written. */ permissionType?: string | null; + /** + * Output only. Metadata about the Privileged Access Manager (PAM) backed authorization decisions. This field is populated if the access is granted via an IAM policy with a binding which is managed by Privileged Access Manager. + */ + privilegedAccessManagerMetadata?: Schema$PrivilegedAccessManagerMetadata; /** * The resource being accessed, as a REST-style or cloud resource string. For example: bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID or projects/PROJECTID/datasets/DATASETID */ @@ -473,6 +490,32 @@ export namespace servicecontrol_v2 { * Indicates the orgpolicy violations for this resource. */ orgPolicyViolationInfo?: Schema$OrgPolicyViolationInfo; + /** + * Indicates the regional access boundary policy violations for this resource. + */ + rabPolicyViolationInfo?: Schema$RabPolicyViolationInfo; + } + /** + * Metadata about the Privileged Access Manager (PAM) backed authorization decisions. + */ + export interface Schema$PrivilegedAccessManagerMetadata { + /** + * Output only. If PAM is managing the elevated access, AuditPamBindingId is written to an Identity and Access Management (IAM) policy, which specifies access controls for resources. If the access is granted via an IAM policy with a binding which is managed by Privileged Access Manager, PrivilegedAccessManagerMetadata will contain the AuditPamBindingId. + */ + pamBindingIds?: Schema$AuditPamBindingId[]; + } + /** + * Represents Regional Access Boundary (RAB) Policy Violation information. + */ + export interface Schema$RabPolicyViolationInfo { + /** + * Optional. Error message detailing what triggered the violation. The error message content originates from the authz library e.g., google3/cloud/security/iam/cap/deny_explanation/internal/make_error_msg.cc. This will be the same (canonical) error message provided by the http error code. + */ + errorMessage?: string | null; + /** + * Optional. The list of target locations of the resource. + */ + resourceLocations?: string[] | null; } /** * Request message for the Report method. diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 588d470623a..6d9419202cd 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -2354,7 +2354,7 @@ export namespace serviceusage_v1 { */ parent?: string | null; /** - * The values removed from the parent consumer policy. + * Deprecated: This field is no longer populated. Use GetConsumerPolicy to verify the remaining enabled values. */ removedValues?: string[] | null; } diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 55bb994ee97..c7788584868 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -2546,7 +2546,7 @@ export namespace serviceusage_v1beta1 { */ parent?: string | null; /** - * The values removed from the parent consumer policy. + * Deprecated: This field is no longer populated. Use GetConsumerPolicy to verify the remaining enabled values. */ removedValues?: string[] | null; } diff --git a/src/apis/threatintelligence/v1beta.ts b/src/apis/threatintelligence/v1beta.ts index 7e7a426acd5..9b133579d69 100644 --- a/src/apis/threatintelligence/v1beta.ts +++ b/src/apis/threatintelligence/v1beta.ts @@ -689,10 +689,18 @@ export namespace threatintelligence_v1beta { * CustomThreatScenarioConfig represents a user-defined threat scenario configuration. */ export interface Schema$CustomThreatScenarioConfig { + /** + * Output only. The compiled Lucene query string. + */ + compiledLuceneQuery?: string | null; /** * Required. The condition driving the scenario, stored as a stringified JSON. This is used to query/filter documents. */ documentCondition?: string | null; + /** + * Optional. Legacy metadata associated with this scenario/monitor. + */ + legacyMonitorMetadata?: Schema$LegacyMetadata; } /** * Captures the specific details of Data Leak alert. @@ -948,6 +956,75 @@ export namespace threatintelligence_v1beta { */ severity?: string | null; } + /** + * Legacy metadata associated with this scenario/monitor. + */ + export interface Schema$LegacyMetadata { + /** + * Optional. Whether aggregation is enabled for alerts from this monitor. + */ + aggregationEnabled?: boolean | null; + /** + * Optional. Similarity threshold for aggregation. + */ + aggregationSimilarity?: number | null; + /** + * Optional. Version of the condition schema. + */ + conditionVersion?: number | null; + /** + * Optional. User ID who created the monitor. + */ + creatorUserId?: string | null; + /** + * Optional. Description of the legacy monitor. + */ + description?: string | null; + /** + * Optional. Code indicating why the monitor is disabled (if applicable). + */ + disabledCode?: string | null; + /** + * Optional. Reason why the monitor is disabled (if applicable). + */ + disabledReason?: string | null; + /** + * Optional. Name of the legacy monitor. + */ + displayName?: string | null; + /** + * Optional. Whether email notifications are enabled. + */ + emailNotificationEnabled?: boolean | null; + /** + * Optional. Whether email notifications are intermediate/immediate. + */ + emailNotificationImmediate?: boolean | null; + /** + * Optional. Unique identifier of the legacy monitor. + */ + legacyMonitorId?: string | null; + /** + * Optional. Time the legacy monitor was considered stale. + */ + staleTime?: string | null; + /** + * Optional. ID of the template this monitor was created from. + */ + templateId?: string | null; + /** + * Optional. ID of the tenant owning the monitor. + */ + tenantId?: string | null; + /** + * Optional. User ID who last updated the monitor. + */ + updaterUserId?: string | null; + /** + * Optional. Version of the monitor configuration. + */ + version?: number | null; + } /** * Response message for ListAlerts. */ diff --git a/src/apis/translate/v3.ts b/src/apis/translate/v3.ts index 17900503402..0b61afc3867 100644 --- a/src/apis/translate/v3.ts +++ b/src/apis/translate/v3.ts @@ -223,6 +223,10 @@ export namespace translate_v3 { * Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned. */ glossaryConfig?: Schema$GlossaryConfig; + /** + * The format of the source text. Currently only text/plain is supported. + */ + mimeType?: string | null; /** * Configuration for caller provided reference sentences. */ @@ -2106,6 +2110,7 @@ export namespace translate_v3 { * // "content": [], * // "dataset": "my_dataset", * // "glossaryConfig": {}, + * // "mimeType": "my_mimeType", * // "referenceSentenceConfig": {} * // } * }, @@ -2982,7 +2987,7 @@ export namespace translate_v3 { } /** - * Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id\}/locations`. This may include public locations as well as private or other locations specifically visible to the project. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -3015,7 +3020,7 @@ export namespace translate_v3 { * * // Do the magic * const res = await translate.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3823,7 +3828,7 @@ export namespace translate_v3 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/translate/v3beta1.ts b/src/apis/translate/v3beta1.ts index 1a3e18d91f3..d12c1ead0c2 100644 --- a/src/apis/translate/v3beta1.ts +++ b/src/apis/translate/v3beta1.ts @@ -2045,7 +2045,7 @@ export namespace translate_v3beta1 { } /** - * Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id\}/locations`. This may include public locations as well as private or other locations specifically visible to the project. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -2078,7 +2078,7 @@ export namespace translate_v3beta1 { * * // Do the magic * const res = await translate.projects.locations.list({ - * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2722,7 +2722,7 @@ export namespace translate_v3beta1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/travelimpactmodel/v1.ts b/src/apis/travelimpactmodel/v1.ts index c19340e738f..1ff77c7429d 100644 --- a/src/apis/travelimpactmodel/v1.ts +++ b/src/apis/travelimpactmodel/v1.ts @@ -306,16 +306,16 @@ export namespace travelimpactmodel_v1 { timWebsiteEmissionsCalculatorUrl?: string | null; } /** - * Information about the provenance of the data used to calculate emissions estimates, including contributing factors and their data sources. + * Information about the provenance of the data used to calculate emissions estimates, including contributing factors and their data sources. In `provenance_entries`, `provenance_entry_type` acts as the "key" identifying the contributing factor, and there is always only one entry per entry type. The remaining fields in each entry describe that specific entry type and may or may not be populated depending on the contributing factor and available data. */ export interface Schema$EmissionsProvenance { /** - * Output only. All contributing factors used to calculate emissions. + * Output only. All contributing factors used to calculate emissions. Each entry type (`provenance_entry_type`) acts as a "key" identifying the factor, with always only one entry per entry type. The remaining fields describe that specific factor and may or may not be populated. */ provenanceEntries?: Schema$EmissionsProvenanceEntry[]; } /** - * Details about a single contributing factor in emissions calculations. + * Details about a single contributing factor in emissions calculations. Each entry represents a single factor where `provenance_entry_type` acts as the key identifying the factor, and the other fields describe it and may or may not be populated. */ export interface Schema$EmissionsProvenanceEntry { /** @@ -355,7 +355,7 @@ export namespace travelimpactmodel_v1 { */ loadFactorsT100Strategy?: string | null; /** - * Output only. The type of the provenance entry. + * Output only. The type of the provenance entry. Acts as the "key" identifying the contributing factor; the remaining fields in this message describe it and may or may not be populated. */ provenanceEntryType?: string | null; /** diff --git a/src/apis/webcontentpublisher/v1.ts b/src/apis/webcontentpublisher/v1.ts index 2251a769ca4..5ccc3fe043b 100644 --- a/src/apis/webcontentpublisher/v1.ts +++ b/src/apis/webcontentpublisher/v1.ts @@ -1593,7 +1593,9 @@ export namespace webcontentpublisher_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: [ + * 'https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -1973,7 +1975,10 @@ export namespace webcontentpublisher_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], + * scopes: [ + * 'https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage', + * 'https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly', + * ], * }); * * // Acquire an auth client, and bind it to all future calls diff --git a/src/apis/workspaceevents/v1.ts b/src/apis/workspaceevents/v1.ts index 4f35df0b2fd..5dd842c5355 100644 --- a/src/apis/workspaceevents/v1.ts +++ b/src/apis/workspaceevents/v1.ts @@ -189,7 +189,7 @@ export namespace workspaceevents_v1 { */ export interface Schema$DriveOptions { /** - * Optional. Immutable. For subscriptions to Google Drive events, whether to receive events about Drive files that are children of the target folder or shared drive. * If `false`, the subscription only receives events about changes to the folder or shared drive that's specified as the `targetResource`. * If `true`, the `mimeType` field of the `file` resource must be set to `application/vnd.google-apps.folder`. For details, see [Google Drive event types](https://developers.google.com/workspace/events/guides/events-drive#event-types). + * Optional. Immutable. For subscriptions to Google Drive events, whether to receive events about Drive files that are children of the target folder or shared drive. This field must be `true` for subscriptions on shared drives. * If `false`, the subscription only receives events about changes to the folder or shared drive that's specified as the `targetResource`. * If `true`, the `mimeType` field of the `file` resource must be set to `application/vnd.google-apps.folder`. For details, see [Google Drive event types](https://developers.google.com/workspace/events/guides/events-drive#event-types). */ includeDescendants?: boolean | null; } diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 3b8816abdfc..2faa3f287d2 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -2334,6 +2334,10 @@ export namespace youtube_v3 { * The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. */ actualStartTime?: string | null; + /** + * The YouTube video category associated with the video broadcast. + */ + categoryId?: string | null; /** * The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast. */ @@ -4002,6 +4006,10 @@ export namespace youtube_v3 { * The default image for this resource. */ default?: Schema$Thumbnail; + /** + * The full high definition (1080p) quality image for this resource. + */ + fhd?: Schema$Thumbnail; /** * The high quality image for this resource. */ @@ -4014,10 +4022,18 @@ export namespace youtube_v3 { * The medium quality image for this resource. */ medium?: Schema$Thumbnail; + /** + * The quad high definition (1440p / 2K) quality image for this resource. + */ + qhd?: Schema$Thumbnail; /** * The standard quality image for this resource. */ standard?: Schema$Thumbnail; + /** + * The ultra-high resolution (4K) quality image for this resource. + */ + uhd?: Schema$Thumbnail; } export interface Schema$ThumbnailSetResponse { /** diff --git a/src/index.ts b/src/index.ts index a593828fb3d..1b556a83a8b 100644 --- a/src/index.ts +++ b/src/index.ts @@ -75,7 +75,6 @@ export {androidpublisher_v2} from './apis/androidpublisher/v2'; 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';