// Copyright 2022 Luca Casonato. All rights reserved. MIT license. /** * Cloud Run Admin API Client for Deno * =================================== * * Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/. * * Docs: https://cloud.google.com/run/ * Source: https://googleapis.deno.dev/v1/run:v2.ts */ import { auth, CredentialsClient, GoogleAuth, request } from "/_/base@v1/mod.ts"; export { auth, GoogleAuth }; export type { CredentialsClient }; /** * Deploy and manage user provided container images that scale automatically * based on incoming requests. The Cloud Run Admin API v1 follows the Knative * Serving API specification, while v2 is aligned with Google Cloud AIP-based * API standards, as described in https://google.aip.dev/. */ export class Run { #client: CredentialsClient | undefined; #baseUrl: string; constructor(client?: CredentialsClient, baseUrl: string = "https://run.googleapis.com/") { this.#client = client; this.#baseUrl = baseUrl; } /** * Submits a build in a given project. * * @param parent Required. The project and location to build in. Location must be a region, e.g., 'us-central1' or 'global' if the global builder is to be used. Format: `projects/{project}/locations/{location}` */ async projectsLocationsBuildsSubmit(parent: string, req: GoogleCloudRunV2SubmitBuildRequest): Promise { req = serializeGoogleCloudRunV2SubmitBuildRequest(req); const url = new URL(`${this.#baseUrl}v2/${ parent }/builds:submit`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as GoogleCloudRunV2SubmitBuildResponse; } /** * Export image for a given resource. * * @param name Required. The name of the resource of which image metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution */ async projectsLocationsExportImage(name: string, req: GoogleCloudRunV2ExportImageRequest): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }:exportImage`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as GoogleCloudRunV2ExportImageResponse; } /** * Export image metadata for a given resource. * * @param name Required. The name of the resource of which image metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution */ async projectsLocationsExportImageMetadata(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }:exportImageMetadata`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as GoogleCloudRunV2Metadata; } /** * Export generated customer metadata for a given resource. * * @param name Required. The name of the resource of which metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}` for Service `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution */ async projectsLocationsExportMetadata(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }:exportMetadata`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as GoogleCloudRunV2Metadata; } /** * Export generated customer metadata for a given project. * * @param name Required. The name of the project of which metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}` for Project in a given location. */ async projectsLocationsExportProjectMetadata(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }:exportProjectMetadata`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as GoogleCloudRunV2Metadata; } /** * Creates a Job. * * @param parent Required. The location and project in which this Job should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. */ async projectsLocationsJobsCreate(parent: string, req: GoogleCloudRunV2Job, opts: ProjectsLocationsJobsCreateOptions = {}): Promise { req = serializeGoogleCloudRunV2Job(req); const url = new URL(`${this.#baseUrl}v2/${ parent }/jobs`); if (opts.jobId !== undefined) { url.searchParams.append("jobId", String(opts.jobId)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as GoogleLongrunningOperation; } /** * Deletes a Job. * * @param name Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number. */ async projectsLocationsJobsDelete(name: string, opts: ProjectsLocationsJobsDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); if (opts.etag !== undefined) { url.searchParams.append("etag", String(opts.etag)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as GoogleLongrunningOperation; } /** * Cancels an Execution. * * @param name Required. The name of the Execution to cancel. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number. */ async projectsLocationsJobsExecutionsCancel(name: string, req: GoogleCloudRunV2CancelExecutionRequest): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }:cancel`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as GoogleLongrunningOperation; } /** * Deletes an Execution. * * @param name Required. The name of the Execution to delete. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number. */ async projectsLocationsJobsExecutionsDelete(name: string, opts: ProjectsLocationsJobsExecutionsDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); if (opts.etag !== undefined) { url.searchParams.append("etag", String(opts.etag)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as GoogleLongrunningOperation; } /** * Read the status of an image export operation. * * @param name Required. The name of the resource of which image export operation status has to be fetched. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution * @param operationId Required. The operation id returned from ExportImage. */ async projectsLocationsJobsExecutionsExportStatus(name: string, operationId: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }/${ operationId }:exportStatus`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as GoogleCloudRunV2ExportStatusResponse; } /** * Gets information about an Execution. * * @param name Required. The full name of the Execution. Format: `projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`, where `{project}` can be project id or number. */ async projectsLocationsJobsExecutionsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as GoogleCloudRunV2Execution; } /** * Lists Executions from a Job. Results are sorted by creation time, * descending. * * @param parent Required. The Execution from which the Executions should be listed. To list all Executions across Jobs, use "-" instead of Job name. Format: `projects/{project}/locations/{location}/jobs/{job}`, where `{project}` can be project id or number. */ async projectsLocationsJobsExecutionsList(parent: string, opts: ProjectsLocationsJobsExecutionsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ parent }/executions`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } if (opts.showDeleted !== undefined) { url.searchParams.append("showDeleted", String(opts.showDeleted)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as GoogleCloudRunV2ListExecutionsResponse; } /** * Gets information about a Task. * * @param name Required. The full name of the Task. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task} */ async projectsLocationsJobsExecutionsTasksGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleCloudRunV2Task(data); } /** * Lists Tasks from an Execution of a Job. * * @param parent Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution} */ async projectsLocationsJobsExecutionsTasksList(parent: string, opts: ProjectsLocationsJobsExecutionsTasksListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ parent }/tasks`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } if (opts.showDeleted !== undefined) { url.searchParams.append("showDeleted", String(opts.showDeleted)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleCloudRunV2ListTasksResponse(data); } /** * Gets information about a Job. * * @param name Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number. */ async projectsLocationsJobsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleCloudRunV2Job(data); } /** * Gets the IAM Access Control policy currently in effect for the given Job. * This result does not include any inherited policies. * * @param resource 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. */ async projectsLocationsJobsGetIamPolicy(resource: string, opts: ProjectsLocationsJobsGetIamPolicyOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ resource }:getIamPolicy`); if (opts["options.requestedPolicyVersion"] !== undefined) { url.searchParams.append("options.requestedPolicyVersion", String(opts["options.requestedPolicyVersion"])); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleIamV1Policy(data); } /** * Lists Jobs. Results are sorted by creation time, descending. * * @param parent Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number. */ async projectsLocationsJobsList(parent: string, opts: ProjectsLocationsJobsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ parent }/jobs`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } if (opts.showDeleted !== undefined) { url.searchParams.append("showDeleted", String(opts.showDeleted)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleCloudRunV2ListJobsResponse(data); } /** * Updates a Job. * * @param name The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job} */ async projectsLocationsJobsPatch(name: string, req: GoogleCloudRunV2Job, opts: ProjectsLocationsJobsPatchOptions = {}): Promise { req = serializeGoogleCloudRunV2Job(req); const url = new URL(`${this.#baseUrl}v2/${ name }`); if (opts.allowMissing !== undefined) { url.searchParams.append("allowMissing", String(opts.allowMissing)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as GoogleLongrunningOperation; } /** * Triggers creation of a new Execution of this Job. * * @param name Required. The full name of the Job. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number. */ async projectsLocationsJobsRun(name: string, req: GoogleCloudRunV2RunJobRequest): Promise { req = serializeGoogleCloudRunV2RunJobRequest(req); const url = new URL(`${this.#baseUrl}v2/${ name }:run`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as GoogleLongrunningOperation; } /** * Sets the IAM Access control policy for the specified Job. Overwrites any * existing policy. * * @param resource 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. */ async projectsLocationsJobsSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise { req = serializeGoogleIamV1SetIamPolicyRequest(req); const url = new URL(`${this.#baseUrl}v2/${ resource }:setIamPolicy`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return deserializeGoogleIamV1Policy(data); } /** * Returns permissions that a caller has on the specified Project. There are * no permissions required for making this API call. * * @param resource 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. */ async projectsLocationsJobsTestIamPermissions(resource: string, req: GoogleIamV1TestIamPermissionsRequest): Promise { const url = new URL(`${this.#baseUrl}v2/${ resource }:testIamPermissions`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as GoogleIamV1TestIamPermissionsResponse; } /** * Deletes a long-running operation. This method indicates that the client is * no longer interested in the operation result. It does not cancel the * operation. If the server doesn't support this method, it returns * `google.rpc.Code.UNIMPLEMENTED`. * * @param name The name of the operation resource to be deleted. */ async projectsLocationsOperationsDelete(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as GoogleProtobufEmpty; } /** * Gets the latest state of a long-running operation. Clients can use this * method to poll the operation result at intervals as recommended by the API * service. * * @param name The name of the operation resource. */ async projectsLocationsOperationsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as GoogleLongrunningOperation; } /** * Lists operations that match the specified filter in the request. If the * server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param name Required. To query for all of the operations for a project. */ async projectsLocationsOperationsList(name: string, opts: ProjectsLocationsOperationsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }/operations`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as GoogleLongrunningListOperationsResponse; } /** * Waits until the specified long-running operation is done or reaches at * most a specified timeout, returning the latest state. If the operation is * already done, the latest state is immediately returned. If the timeout * specified is greater than the default HTTP/RPC timeout, the HTTP/RPC * timeout is used. If the server does not support this method, it returns * `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort * basis. It may return the latest state before the specified timeout * (including immediately), meaning even an immediate response is no guarantee * that the operation is done. * * @param name The name of the operation resource to wait on. */ async projectsLocationsOperationsWait(name: string, req: GoogleLongrunningWaitOperationRequest): Promise { req = serializeGoogleLongrunningWaitOperationRequest(req); const url = new URL(`${this.#baseUrl}v2/${ name }:wait`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as GoogleLongrunningOperation; } /** * Creates a new Service in a given project and location. * * @param parent Required. The location and project in which this service should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens. */ async projectsLocationsServicesCreate(parent: string, req: GoogleCloudRunV2Service, opts: ProjectsLocationsServicesCreateOptions = {}): Promise { req = serializeGoogleCloudRunV2Service(req); const url = new URL(`${this.#baseUrl}v2/${ parent }/services`); if (opts.serviceId !== undefined) { url.searchParams.append("serviceId", String(opts.serviceId)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as GoogleLongrunningOperation; } /** * Deletes a Service. This will cause the Service to stop serving traffic and * will delete all revisions. * * @param name Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number. */ async projectsLocationsServicesDelete(name: string, opts: ProjectsLocationsServicesDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); if (opts.etag !== undefined) { url.searchParams.append("etag", String(opts.etag)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as GoogleLongrunningOperation; } /** * Gets information about a Service. * * @param name Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number. */ async projectsLocationsServicesGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleCloudRunV2Service(data); } /** * Gets the IAM Access Control policy currently in effect for the given Cloud * Run Service. This result does not include any inherited policies. * * @param resource 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. */ async projectsLocationsServicesGetIamPolicy(resource: string, opts: ProjectsLocationsServicesGetIamPolicyOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ resource }:getIamPolicy`); if (opts["options.requestedPolicyVersion"] !== undefined) { url.searchParams.append("options.requestedPolicyVersion", String(opts["options.requestedPolicyVersion"])); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleIamV1Policy(data); } /** * Lists Services. Results are sorted by creation time, descending. * * @param parent Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the "-" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number. */ async projectsLocationsServicesList(parent: string, opts: ProjectsLocationsServicesListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ parent }/services`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } if (opts.showDeleted !== undefined) { url.searchParams.append("showDeleted", String(opts.showDeleted)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleCloudRunV2ListServicesResponse(data); } /** * Updates a Service. * * @param name The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} */ async projectsLocationsServicesPatch(name: string, req: GoogleCloudRunV2Service, opts: ProjectsLocationsServicesPatchOptions = {}): Promise { req = serializeGoogleCloudRunV2Service(req); opts = serializeProjectsLocationsServicesPatchOptions(opts); const url = new URL(`${this.#baseUrl}v2/${ name }`); if (opts.allowMissing !== undefined) { url.searchParams.append("allowMissing", String(opts.allowMissing)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as GoogleLongrunningOperation; } /** * Deletes a Revision. * * @param name Required. The name of the Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision} */ async projectsLocationsServicesRevisionsDelete(name: string, opts: ProjectsLocationsServicesRevisionsDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); if (opts.etag !== undefined) { url.searchParams.append("etag", String(opts.etag)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as GoogleLongrunningOperation; } /** * Read the status of an image export operation. * * @param name Required. The name of the resource of which image export operation status has to be fetched. Format: `projects/{project_id_or_number}/locations/{location}/services/{service}/revisions/{revision}` for Revision `projects/{project_id_or_number}/locations/{location}/jobs/{job}/executions/{execution}` for Execution * @param operationId Required. The operation id returned from ExportImage. */ async projectsLocationsServicesRevisionsExportStatus(name: string, operationId: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }/${ operationId }:exportStatus`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as GoogleCloudRunV2ExportStatusResponse; } /** * Gets information about a Revision. * * @param name Required. The full name of the Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision} */ async projectsLocationsServicesRevisionsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v2/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleCloudRunV2Revision(data); } /** * Lists Revisions from a given Service, or from a given location. Results * are sorted by creation time, descending. * * @param parent Required. The Service from which the Revisions should be listed. To list all Revisions across Services, use "-" instead of Service name. Format: projects/{project}/locations/{location}/services/{service} */ async projectsLocationsServicesRevisionsList(parent: string, opts: ProjectsLocationsServicesRevisionsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v2/${ parent }/revisions`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } if (opts.showDeleted !== undefined) { url.searchParams.append("showDeleted", String(opts.showDeleted)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeGoogleCloudRunV2ListRevisionsResponse(data); } /** * Sets the IAM Access control policy for the specified Service. Overwrites * any existing policy. * * @param resource 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. */ async projectsLocationsServicesSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise { req = serializeGoogleIamV1SetIamPolicyRequest(req); const url = new URL(`${this.#baseUrl}v2/${ resource }:setIamPolicy`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return deserializeGoogleIamV1Policy(data); } /** * Returns permissions that a caller has on the specified Project. There are * no permissions required for making this API call. * * @param resource 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. */ async projectsLocationsServicesTestIamPermissions(resource: string, req: GoogleIamV1TestIamPermissionsRequest): Promise { const url = new URL(`${this.#baseUrl}v2/${ resource }:testIamPermissions`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as GoogleIamV1TestIamPermissionsResponse; } } /** * Settings for Binary Authorization feature. */ export interface GoogleCloudRunV2BinaryAuthorization { /** * Optional. If present, indicates to use Breakglass using this * justification. If use_default is False, then it must be empty. For more * information on breakglass, see * https://cloud.google.com/binary-authorization/docs/using-breakglass */ breakglassJustification?: string; /** * Optional. The path to a binary authorization policy. Format: * `projects/{project}/platforms/cloudRun/{policy-name}` */ policy?: string; /** * Optional. If True, indicates to use the default project's binary * authorization policy. If False, binary authorization will be disabled. */ useDefault?: boolean; } /** * Build the source using Buildpacks. */ export interface GoogleCloudRunV2BuildpacksBuild { /** * Optional. The base image used to opt into automatic base image updates. */ baseImage?: string; /** * Optional. cache_image_uri is the GCR/AR URL where the cache image will be * stored. cache_image_uri is optional and omitting it will disable caching. * This URL must be stable across builds. It is used to derive a * build-specific temporary URL by substituting the tag with the build ID. The * build will clean up the temporary image on a best-effort basis. */ cacheImageUri?: string; /** * Optional. Whether or not the application container will be enrolled in * automatic base image updates. When true, the application will be built on a * scratch base image, so the base layers can be appended at run time. */ enableAutomaticUpdates?: boolean; /** * Optional. User-provided build-time environment variables. */ environmentVariables?: { [key: string]: string }; /** * Optional. Name of the function target if the source is a function source. * Required for function builds. */ functionTarget?: string; /** * Optional. project_descriptor stores the path to the project descriptor * file. When empty, it means that there is no project descriptor file in the * source. */ projectDescriptor?: string; /** * The runtime name, e.g. 'go113'. Leave blank for generic builds. */ runtime?: string; } /** * Request message for deleting an Execution. */ export interface GoogleCloudRunV2CancelExecutionRequest { /** * A system-generated fingerprint for this version of the resource. This may * be used to detect modification conflict during updates. */ etag?: string; /** * Indicates that the request should be validated without actually cancelling * any resources. */ validateOnly?: boolean; } /** * Represents a set of Cloud SQL instances. Each one will be available under * /cloudsql/[instance]. Visit * https://cloud.google.com/sql/docs/mysql/connect-run for more information on * how to connect Cloud SQL and Cloud Run. */ export interface GoogleCloudRunV2CloudSqlInstance { /** * The Cloud SQL instance connection names, as can be found in * https://console.cloud.google.com/sql/instances. Visit * https://cloud.google.com/sql/docs/mysql/connect-run for more information on * how to connect Cloud SQL and Cloud Run. Format: * {project}:{location}:{instance} */ instances?: string[]; } /** * Defines a status condition for a resource. */ export interface GoogleCloudRunV2Condition { /** * Output only. A reason for the execution condition. */ readonly executionReason?: | "EXECUTION_REASON_UNDEFINED" | "JOB_STATUS_SERVICE_POLLING_ERROR" | "NON_ZERO_EXIT_CODE" | "CANCELLED" | "CANCELLING" | "DELETED"; /** * Last time the condition transitioned from one status to another. */ lastTransitionTime?: Date; /** * Human readable message indicating details about the current status. */ message?: string; /** * Output only. A common (service-level) reason for this condition. */ readonly reason?: | "COMMON_REASON_UNDEFINED" | "UNKNOWN" | "REVISION_FAILED" | "PROGRESS_DEADLINE_EXCEEDED" | "CONTAINER_MISSING" | "CONTAINER_PERMISSION_DENIED" | "CONTAINER_IMAGE_UNAUTHORIZED" | "CONTAINER_IMAGE_AUTHORIZATION_CHECK_FAILED" | "ENCRYPTION_KEY_PERMISSION_DENIED" | "ENCRYPTION_KEY_CHECK_FAILED" | "SECRETS_ACCESS_CHECK_FAILED" | "WAITING_FOR_OPERATION" | "IMMEDIATE_RETRY" | "POSTPONED_RETRY" | "INTERNAL"; /** * Output only. A reason for the revision condition. */ readonly revisionReason?: | "REVISION_REASON_UNDEFINED" | "PENDING" | "RESERVE" | "RETIRED" | "RETIRING" | "RECREATING" | "HEALTH_CHECK_CONTAINER_ERROR" | "CUSTOMIZED_PATH_RESPONSE_PENDING" | "MIN_INSTANCES_NOT_PROVISIONED" | "ACTIVE_REVISION_LIMIT_REACHED" | "NO_DEPLOYMENT" | "HEALTH_CHECK_SKIPPED" | "MIN_INSTANCES_WARMING"; /** * How to interpret failures of this condition, one of Error, Warning, Info */ severity?: | "SEVERITY_UNSPECIFIED" | "ERROR" | "WARNING" | "INFO"; /** * State of the condition. */ state?: | "STATE_UNSPECIFIED" | "CONDITION_PENDING" | "CONDITION_RECONCILING" | "CONDITION_FAILED" | "CONDITION_SUCCEEDED"; /** * type is used to communicate the status of the reconciliation process. See * also: * https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting * Types common to all resources include: * "Ready": True when the Resource is * ready. */ type?: string; } function serializeGoogleCloudRunV2Condition(data: any): GoogleCloudRunV2Condition { return { ...data, lastTransitionTime: data["lastTransitionTime"] !== undefined ? data["lastTransitionTime"].toISOString() : undefined, }; } function deserializeGoogleCloudRunV2Condition(data: any): GoogleCloudRunV2Condition { return { ...data, lastTransitionTime: data["lastTransitionTime"] !== undefined ? new Date(data["lastTransitionTime"]) : undefined, }; } /** * A single application container. This specifies both the container to run, * the command to run in the container and the arguments to supply to it. Note * that additional arguments can be supplied by the system to the container at * runtime. */ export interface GoogleCloudRunV2Container { /** * Arguments to the entrypoint. The docker image's CMD is used if this is not * provided. */ args?: string[]; /** * Entrypoint array. Not executed within a shell. The docker image's * ENTRYPOINT is used if this is not provided. */ command?: string[]; /** * Names of the containers that must start before this container. */ dependsOn?: string[]; /** * List of environment variables to set in the container. */ env?: GoogleCloudRunV2EnvVar[]; /** * Required. Name of the container image in Dockerhub, Google Artifact * Registry, or Google Container Registry. If the host is not provided, * Dockerhub is assumed. */ image?: string; /** * Periodic probe of container liveness. Container will be restarted if the * probe fails. */ livenessProbe?: GoogleCloudRunV2Probe; /** * Name of the container specified as a DNS_LABEL (RFC 1123). */ name?: string; /** * List of ports to expose from the container. Only a single port can be * specified. The specified ports must be listening on all interfaces * (0.0.0.0) within the container to be accessible. If omitted, a port number * will be chosen and passed to the container through the PORT environment * variable for the container to listen on. */ ports?: GoogleCloudRunV2ContainerPort[]; /** * Compute Resource requirements by this container. */ resources?: GoogleCloudRunV2ResourceRequirements; /** * Startup probe of application within the container. All other probes are * disabled if a startup probe is provided, until it succeeds. Container will * not be added to service endpoints if the probe fails. */ startupProbe?: GoogleCloudRunV2Probe; /** * Volume to mount into the container's filesystem. */ volumeMounts?: GoogleCloudRunV2VolumeMount[]; /** * Container's working directory. If not specified, the container runtime's * default will be used, which might be configured in the container image. */ workingDir?: string; } /** * Per-container override specification. */ export interface GoogleCloudRunV2ContainerOverride { /** * Optional. Arguments to the entrypoint. Will replace existing args for * override. */ args?: string[]; /** * Optional. True if the intention is to clear out existing args list. */ clearArgs?: boolean; /** * List of environment variables to set in the container. Will be merged with * existing env for override. */ env?: GoogleCloudRunV2EnvVar[]; /** * The name of the container specified as a DNS_LABEL. */ name?: string; } /** * ContainerPort represents a network port in a single container. */ export interface GoogleCloudRunV2ContainerPort { /** * Port number the container listens on. This must be a valid TCP port * number, 0 < container_port < 65536. */ containerPort?: number; /** * If specified, used to specify which protocol to use. Allowed values are * "http1" and "h2c". */ name?: string; } /** * Build the source using Docker. This means the source has a Dockerfile. */ export interface GoogleCloudRunV2DockerBuild { } /** * In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when * the sandbox is taken down, the data is destroyed with it (it does not persist * across sandbox runs). */ export interface GoogleCloudRunV2EmptyDirVolumeSource { /** * The medium on which the data is stored. Acceptable values today is only * MEMORY or none. When none, the default will currently be backed by memory * but could change over time. +optional */ medium?: | "MEDIUM_UNSPECIFIED" | "MEMORY"; /** * Limit on the storage usable by this EmptyDir volume. The size limit is * also applicable for memory medium. The maximum usage on memory medium * EmptyDir would be the minimum value between the SizeLimit specified here * and the sum of memory limits of all containers. The default is nil which * means that the limit is undefined. More info: * https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. * Info in Kubernetes: * https://kubernetes.io/docs/concepts/storage/volumes/#emptydir */ sizeLimit?: string; } /** * EnvVar represents an environment variable present in a Container. */ export interface GoogleCloudRunV2EnvVar { /** * Required. Name of the environment variable. Must not exceed 32768 * characters. */ name?: string; /** * Literal value of the environment variable. Defaults to "", and the maximum * length is 32768 bytes. Variable references are not supported in Cloud Run. */ value?: string; /** * Source for the environment variable's value. */ valueSource?: GoogleCloudRunV2EnvVarSource; } /** * EnvVarSource represents a source for the value of an EnvVar. */ export interface GoogleCloudRunV2EnvVarSource { /** * Selects a secret and a specific version from Cloud Secret Manager. */ secretKeyRef?: GoogleCloudRunV2SecretKeySelector; } /** * Execution represents the configuration of a single execution. A execution an * immutable resource that references a container image which is run to * completion. */ export interface GoogleCloudRunV2Execution { /** * Output only. Unstructured key value map that may be set by external tools * to store and arbitrary metadata. They are not queryable and should be * preserved when modifying objects. */ readonly annotations?: { [key: string]: string }; /** * Output only. The number of tasks which reached phase Cancelled. */ readonly cancelledCount?: number; /** * Output only. Represents time when the execution was completed. It is not * guaranteed to be set in happens-before order across separate operations. */ readonly completionTime?: Date; /** * Output only. The Condition of this Execution, containing its readiness * status, and detailed error information in case it did not reach the desired * state. */ readonly conditions?: GoogleCloudRunV2Condition[]; /** * Output only. Represents time when the execution was acknowledged by the * execution controller. It is not guaranteed to be set in happens-before * order across separate operations. */ readonly createTime?: Date; /** * Output only. For a deleted resource, the deletion time. It is only * populated as a response to a Delete request. */ readonly deleteTime?: Date; /** * Output only. A system-generated fingerprint for this version of the * resource. May be used to detect modification conflict during updates. */ readonly etag?: string; /** * Output only. For a deleted resource, the time after which it will be * permamently deleted. It is only populated as a response to a Delete * request. */ readonly expireTime?: Date; /** * Output only. The number of tasks which reached phase Failed. */ readonly failedCount?: number; /** * Output only. A number that monotonically increases every time the user * modifies the desired state. */ readonly generation?: bigint; /** * Output only. The name of the parent Job. */ readonly job?: string; /** * Output only. 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 */ readonly labels?: { [key: string]: string }; /** * The least stable launch stage needed to create this resource, as defined * by [Google Cloud Platform Launch * Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports * `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used * as input. For example, if ALPHA was provided as input in the parent * resource, but only BETA and GA-level features are were, this field will be * BETA. */ launchStage?: | "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"; /** * Output only. URI where logs for this execution can be found in Cloud * Console. */ readonly logUri?: string; /** * Output only. The unique name of this Execution. */ readonly name?: string; /** * Output only. The generation of this Execution. See comments in * `reconciling` for additional information on reconciliation process in Cloud * Run. */ readonly observedGeneration?: bigint; /** * Output only. Specifies the maximum desired number of tasks the execution * should run at any given time. Must be <= task_count. The actual number of * tasks running in steady state will be less than this number when * ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when * the work left to do is less than max parallelism. */ readonly parallelism?: number; /** * Output only. Indicates whether the resource's reconciliation is still in * progress. See comments in `Job.reconciling` for additional information on * reconciliation process in Cloud Run. */ readonly reconciling?: boolean; /** * Output only. The number of tasks which have retried at least once. */ readonly retriedCount?: number; /** * Output only. The number of actively running tasks. */ readonly runningCount?: number; /** * Output only. Reserved for future use. */ readonly satisfiesPzs?: boolean; /** * Output only. Represents time when the execution started to run. It is not * guaranteed to be set in happens-before order across separate operations. */ readonly startTime?: Date; /** * Output only. The number of tasks which reached phase Succeeded. */ readonly succeededCount?: number; /** * Output only. Specifies the desired number of tasks the execution should * run. Setting to 1 means that parallelism is limited to 1 and the success of * that task signals the success of the execution. */ readonly taskCount?: number; /** * Output only. The template used to create tasks for this execution. */ readonly template?: GoogleCloudRunV2TaskTemplate; /** * Output only. Server assigned unique identifier for the Execution. The * value is a UUID4 string and guaranteed to remain unchanged until the * resource is deleted. */ readonly uid?: string; /** * Output only. The last-modified time. */ readonly updateTime?: Date; } /** * Reference to an Execution. Use /Executions.GetExecution with the given name * to get full execution including the latest status. */ export interface GoogleCloudRunV2ExecutionReference { /** * Status for the execution completion. */ completionStatus?: | "COMPLETION_STATUS_UNSPECIFIED" | "EXECUTION_SUCCEEDED" | "EXECUTION_FAILED" | "EXECUTION_RUNNING" | "EXECUTION_PENDING" | "EXECUTION_CANCELLED"; /** * Creation timestamp of the execution. */ completionTime?: Date; /** * Creation timestamp of the execution. */ createTime?: Date; /** * The deletion time of the execution. It is only populated as a response to * a Delete request. */ deleteTime?: Date; /** * Name of the execution. */ name?: string; } function serializeGoogleCloudRunV2ExecutionReference(data: any): GoogleCloudRunV2ExecutionReference { return { ...data, completionTime: data["completionTime"] !== undefined ? data["completionTime"].toISOString() : undefined, createTime: data["createTime"] !== undefined ? data["createTime"].toISOString() : undefined, deleteTime: data["deleteTime"] !== undefined ? data["deleteTime"].toISOString() : undefined, }; } function deserializeGoogleCloudRunV2ExecutionReference(data: any): GoogleCloudRunV2ExecutionReference { return { ...data, completionTime: data["completionTime"] !== undefined ? new Date(data["completionTime"]) : undefined, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, deleteTime: data["deleteTime"] !== undefined ? new Date(data["deleteTime"]) : undefined, }; } /** * ExecutionTemplate describes the data an execution should have when created * from a template. */ export interface GoogleCloudRunV2ExecutionTemplate { /** * Unstructured key value map that may be set by external tools to store and * arbitrary metadata. They are not queryable and should be preserved when * modifying objects. Cloud Run API v2 does not support annotations with * `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or * `autoscaling.knative.dev` namespaces, and they will be rejected. All system * annotations in v1 now have a corresponding field in v2 ExecutionTemplate. * This field follows Kubernetes annotations' namespacing, limits, and rules. */ annotations?: { [key: string]: string }; /** * 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. */ labels?: { [key: string]: string }; /** * Specifies the maximum desired number of tasks the execution should run at * given time. Must be <= task_count. 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 remaining, i.e. * when the work left to do is less than max parallelism. */ parallelism?: number; /** * Specifies the desired number of tasks the execution should run. Setting to * 1 means that parallelism is limited to 1 and the success of that task * signals the success of the execution. Defaults to 1. */ taskCount?: number; /** * Required. Describes the task(s) that will be created when executing an * execution. */ template?: GoogleCloudRunV2TaskTemplate; } function serializeGoogleCloudRunV2ExecutionTemplate(data: any): GoogleCloudRunV2ExecutionTemplate { return { ...data, template: data["template"] !== undefined ? serializeGoogleCloudRunV2TaskTemplate(data["template"]) : undefined, }; } function deserializeGoogleCloudRunV2ExecutionTemplate(data: any): GoogleCloudRunV2ExecutionTemplate { return { ...data, template: data["template"] !== undefined ? deserializeGoogleCloudRunV2TaskTemplate(data["template"]) : undefined, }; } /** * Request message for exporting Cloud Run image. */ export interface GoogleCloudRunV2ExportImageRequest { /** * Required. The export destination url (the Artifact Registry repo). */ destinationRepo?: string; } /** * ExportImageResponse contains an operation Id to track the image export * operation. */ export interface GoogleCloudRunV2ExportImageResponse { /** * An operation ID used to track the status of image exports tied to the * original pod ID in the request. */ operationId?: string; } /** * ExportStatusResponse contains the status of image export operation, with the * status of each image export job. */ export interface GoogleCloudRunV2ExportStatusResponse { /** * The status of each image export job. */ imageExportStatuses?: GoogleCloudRunV2ImageExportStatus[]; /** * The operation id. */ operationId?: string; /** * Output only. The state of the overall export operation. */ readonly operationState?: | "OPERATION_STATE_UNSPECIFIED" | "IN_PROGRESS" | "FINISHED"; } /** * Represents a volume backed by a Cloud Storage bucket using Cloud Storage * FUSE. */ export interface GoogleCloudRunV2GCSVolumeSource { /** * Cloud Storage Bucket name. */ bucket?: string; /** * A list of additional flags to pass to the gcsfuse CLI. Options should be * specified without the leading "--". */ mountOptions?: string[]; /** * If true, the volume will be mounted as read only for all mounts. */ readOnly?: boolean; } /** * GRPCAction describes an action involving a GRPC port. */ export interface GoogleCloudRunV2GRPCAction { /** * Optional. Port number of the gRPC service. Number must be in the range 1 * to 65535. If not specified, defaults to the exposed port of the container, * which is the value of container.ports[0].containerPort. */ port?: number; /** * Optional. Service is the name of the service to place in the gRPC * HealthCheckRequest (see * https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this * is not specified, the default behavior is defined by gRPC. */ service?: string; } /** * HTTPGetAction describes an action based on HTTP Get requests. */ export interface GoogleCloudRunV2HTTPGetAction { /** * Optional. Custom headers to set in the request. HTTP allows repeated * headers. */ httpHeaders?: GoogleCloudRunV2HTTPHeader[]; /** * Optional. Path to access on the HTTP server. Defaults to '/'. */ path?: string; /** * Optional. Port number to access on the container. Must be in the range 1 * to 65535. If not specified, defaults to the exposed port of the container, * which is the value of container.ports[0].containerPort. */ port?: number; } /** * HTTPHeader describes a custom header to be used in HTTP probes */ export interface GoogleCloudRunV2HTTPHeader { /** * Required. The header field name */ name?: string; /** * Optional. The header field value */ value?: string; } /** * The status of an image export job. */ export interface GoogleCloudRunV2ImageExportStatus { /** * The exported image ID as it will appear in Artifact Registry. */ exportedImageDigest?: string; /** * Output only. Has the image export job finished (regardless of successful * or failure). */ readonly exportJobState?: | "EXPORT_JOB_STATE_UNSPECIFIED" | "IN_PROGRESS" | "FINISHED"; /** * The status of the export task if done. */ status?: UtilStatusProto; /** * The image tag as it will appear in Artifact Registry. */ tag?: string; } /** * Job represents the configuration of a single job, which references a * container image that is run to completion. */ export interface GoogleCloudRunV2Job { /** * Unstructured key value map that may be set by external tools to store and * arbitrary metadata. They are not queryable and should be preserved when * modifying objects. Cloud Run API v2 does not support annotations with * `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or * `autoscaling.knative.dev` namespaces, and they will be rejected on new * resources. All system annotations in v1 now have a corresponding field in * v2 Job. This field follows Kubernetes annotations' namespacing, limits, and * rules. */ annotations?: { [key: string]: string }; /** * Settings for the Binary Authorization feature. */ binaryAuthorization?: GoogleCloudRunV2BinaryAuthorization; /** * Arbitrary identifier for the API client. */ client?: string; /** * Arbitrary version identifier for the API client. */ clientVersion?: string; /** * Output only. The Conditions of all other associated sub-resources. They * contain additional diagnostics information in case the Job does not reach * its desired state. See comments in `reconciling` for additional information * on reconciliation process in Cloud Run. */ readonly conditions?: GoogleCloudRunV2Condition[]; /** * Output only. The creation time. */ readonly createTime?: Date; /** * Output only. Email address of the authenticated creator. */ readonly creator?: string; /** * Output only. The deletion time. It is only populated as a response to a * Delete request. */ readonly deleteTime?: Date; /** * Output only. A system-generated fingerprint for this version of the * resource. May be used to detect modification conflict during updates. */ readonly etag?: string; /** * Output only. Number of executions created for this job. */ readonly executionCount?: number; /** * Output only. For a deleted resource, the time after which it will be * permamently deleted. */ readonly expireTime?: Date; /** * Output only. A number that monotonically increases every time the user * modifies the desired state. */ readonly generation?: bigint; /** * 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 Job. */ labels?: { [key: string]: string }; /** * Output only. Email address of the last authenticated modifier. */ readonly lastModifier?: string; /** * Output only. Name of the last created execution. */ readonly latestCreatedExecution?: GoogleCloudRunV2ExecutionReference; /** * The launch stage as defined by [Google Cloud Platform Launch * Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports * `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the * launch stage to a preview stage on input to allow use of preview features * in that stage. On read (or output), describes whether the resource uses * preview features. For example, if ALPHA is provided as input, but only BETA * and GA-level features are used, this field will be BETA on output. */ launchStage?: | "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"; /** * The fully qualified name of this Job. Format: * projects/{project}/locations/{location}/jobs/{job} */ name?: string; /** * Output only. The generation of this Job. See comments in `reconciling` for * additional information on reconciliation process in Cloud Run. */ readonly observedGeneration?: bigint; /** * Output only. Returns true if the Job is currently being acted upon by the * system to bring it into the desired state. When a new Job is created, or an * existing one is updated, Cloud Run will asynchronously perform all * necessary steps to bring the Job to the desired state. This process is * called reconciliation. While reconciliation is in process, * `observed_generation` and `latest_succeeded_execution`, will have transient * values that might mismatch the intended state: Once reconciliation is over * (and this field is false), there are two possible outcomes: reconciliation * succeeded and the state matches the Job, or there was an error, and * reconciliation failed. This state can be found in * `terminal_condition.state`. If reconciliation succeeded, the following * fields will match: `observed_generation` and `generation`, * `latest_succeeded_execution` and `latest_created_execution`. If * reconciliation failed, `observed_generation` and * `latest_succeeded_execution` will have the state of the last succeeded * execution or empty for newly created Job. Additional information on the * failure can be found in `terminal_condition` and `conditions`. */ readonly reconciling?: boolean; /** * A unique string used as a suffix for creating a new execution. The Job * will become ready when the execution is successfully completed. The sum of * job name and token length must be fewer than 63 characters. */ runExecutionToken?: string; /** * Output only. Reserved for future use. */ readonly satisfiesPzs?: boolean; /** * A unique string used as a suffix creating a new execution. The Job will * become ready when the execution is successfully started. The sum of job * name and token length must be fewer than 63 characters. */ startExecutionToken?: string; /** * Required. The template used to create executions for this Job. */ template?: GoogleCloudRunV2ExecutionTemplate; /** * Output only. The Condition of this Job, containing its readiness status, * and detailed error information in case it did not reach the desired state. */ readonly terminalCondition?: GoogleCloudRunV2Condition; /** * Output only. Server assigned unique identifier for the Execution. The * value is a UUID4 string and guaranteed to remain unchanged until the * resource is deleted. */ readonly uid?: string; /** * Output only. The last-modified time. */ readonly updateTime?: Date; } function serializeGoogleCloudRunV2Job(data: any): GoogleCloudRunV2Job { return { ...data, template: data["template"] !== undefined ? serializeGoogleCloudRunV2ExecutionTemplate(data["template"]) : undefined, }; } function deserializeGoogleCloudRunV2Job(data: any): GoogleCloudRunV2Job { return { ...data, conditions: data["conditions"] !== undefined ? data["conditions"].map((item: any) => (deserializeGoogleCloudRunV2Condition(item))) : undefined, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, deleteTime: data["deleteTime"] !== undefined ? new Date(data["deleteTime"]) : undefined, expireTime: data["expireTime"] !== undefined ? new Date(data["expireTime"]) : undefined, generation: data["generation"] !== undefined ? BigInt(data["generation"]) : undefined, latestCreatedExecution: data["latestCreatedExecution"] !== undefined ? deserializeGoogleCloudRunV2ExecutionReference(data["latestCreatedExecution"]) : undefined, observedGeneration: data["observedGeneration"] !== undefined ? BigInt(data["observedGeneration"]) : undefined, template: data["template"] !== undefined ? deserializeGoogleCloudRunV2ExecutionTemplate(data["template"]) : undefined, terminalCondition: data["terminalCondition"] !== undefined ? deserializeGoogleCloudRunV2Condition(data["terminalCondition"]) : undefined, updateTime: data["updateTime"] !== undefined ? new Date(data["updateTime"]) : undefined, }; } /** * Response message containing a list of Executions. */ export interface GoogleCloudRunV2ListExecutionsResponse { /** * The resulting list of Executions. */ executions?: GoogleCloudRunV2Execution[]; /** * A token indicating there are more items than page_size. Use it in the next * ListExecutions request to continue. */ nextPageToken?: string; } /** * Response message containing a list of Jobs. */ export interface GoogleCloudRunV2ListJobsResponse { /** * The resulting list of Jobs. */ jobs?: GoogleCloudRunV2Job[]; /** * A token indicating there are more items than page_size. Use it in the next * ListJobs request to continue. */ nextPageToken?: string; } function serializeGoogleCloudRunV2ListJobsResponse(data: any): GoogleCloudRunV2ListJobsResponse { return { ...data, jobs: data["jobs"] !== undefined ? data["jobs"].map((item: any) => (serializeGoogleCloudRunV2Job(item))) : undefined, }; } function deserializeGoogleCloudRunV2ListJobsResponse(data: any): GoogleCloudRunV2ListJobsResponse { return { ...data, jobs: data["jobs"] !== undefined ? data["jobs"].map((item: any) => (deserializeGoogleCloudRunV2Job(item))) : undefined, }; } /** * Response message containing a list of Revisions. */ export interface GoogleCloudRunV2ListRevisionsResponse { /** * A token indicating there are more items than page_size. Use it in the next * ListRevisions request to continue. */ nextPageToken?: string; /** * The resulting list of Revisions. */ revisions?: GoogleCloudRunV2Revision[]; } function serializeGoogleCloudRunV2ListRevisionsResponse(data: any): GoogleCloudRunV2ListRevisionsResponse { return { ...data, revisions: data["revisions"] !== undefined ? data["revisions"].map((item: any) => (serializeGoogleCloudRunV2Revision(item))) : undefined, }; } function deserializeGoogleCloudRunV2ListRevisionsResponse(data: any): GoogleCloudRunV2ListRevisionsResponse { return { ...data, revisions: data["revisions"] !== undefined ? data["revisions"].map((item: any) => (deserializeGoogleCloudRunV2Revision(item))) : undefined, }; } /** * Response message containing a list of Services. */ export interface GoogleCloudRunV2ListServicesResponse { /** * A token indicating there are more items than page_size. Use it in the next * ListServices request to continue. */ nextPageToken?: string; /** * The resulting list of Services. */ services?: GoogleCloudRunV2Service[]; } function serializeGoogleCloudRunV2ListServicesResponse(data: any): GoogleCloudRunV2ListServicesResponse { return { ...data, services: data["services"] !== undefined ? data["services"].map((item: any) => (serializeGoogleCloudRunV2Service(item))) : undefined, }; } function deserializeGoogleCloudRunV2ListServicesResponse(data: any): GoogleCloudRunV2ListServicesResponse { return { ...data, services: data["services"] !== undefined ? data["services"].map((item: any) => (deserializeGoogleCloudRunV2Service(item))) : undefined, }; } /** * Response message containing a list of Tasks. */ export interface GoogleCloudRunV2ListTasksResponse { /** * A token indicating there are more items than page_size. Use it in the next * ListTasks request to continue. */ nextPageToken?: string; /** * The resulting list of Tasks. */ tasks?: GoogleCloudRunV2Task[]; } function serializeGoogleCloudRunV2ListTasksResponse(data: any): GoogleCloudRunV2ListTasksResponse { return { ...data, tasks: data["tasks"] !== undefined ? data["tasks"].map((item: any) => (serializeGoogleCloudRunV2Task(item))) : undefined, }; } function deserializeGoogleCloudRunV2ListTasksResponse(data: any): GoogleCloudRunV2ListTasksResponse { return { ...data, tasks: data["tasks"] !== undefined ? data["tasks"].map((item: any) => (deserializeGoogleCloudRunV2Task(item))) : undefined, }; } /** * Metadata represents the JSON encoded generated customer metadata. */ export interface GoogleCloudRunV2Metadata { /** * JSON encoded Google-generated Customer Metadata for a given * resource/project. */ metadata?: string; } /** * Direct VPC egress settings. */ export interface GoogleCloudRunV2NetworkInterface { /** * Optional. The VPC network that the Cloud Run resource will be able to send * traffic to. At least one of network or subnetwork must be specified. If * both network and subnetwork are specified, the given VPC subnetwork must * belong to the given VPC network. If network is not specified, it will be * looked up from the subnetwork. */ network?: string; /** * Optional. The VPC subnetwork that the Cloud Run resource will get IPs * from. At least one of network or subnetwork must be specified. If both * network and subnetwork are specified, the given VPC subnetwork must belong * to the given VPC network. If subnetwork is not specified, the subnetwork * with the same name with the network will be used. */ subnetwork?: string; /** * Optional. Network tags applied to this Cloud Run resource. */ tags?: string[]; } /** * Represents an NFS mount. */ export interface GoogleCloudRunV2NFSVolumeSource { /** * Path that is exported by the NFS server. */ path?: string; /** * If true, the volume will be mounted as read only for all mounts. */ readOnly?: boolean; /** * Hostname or IP address of the NFS server */ server?: string; } /** * Hardware constraints configuration. */ export interface GoogleCloudRunV2NodeSelector { /** * Required. GPU accelerator type to attach to an instance. */ accelerator?: string; } /** * RunJob Overrides that contains Execution fields to be overridden. */ export interface GoogleCloudRunV2Overrides { /** * Per container override specification. */ containerOverrides?: GoogleCloudRunV2ContainerOverride[]; /** * Optional. The desired number of tasks the execution should run. Will * replace existing task_count value. */ taskCount?: number; /** * Duration in seconds the task may be active before the system will actively * try to mark it failed and kill associated containers. Will replace existing * timeout_seconds value. */ timeout?: number /* Duration */; } function serializeGoogleCloudRunV2Overrides(data: any): GoogleCloudRunV2Overrides { return { ...data, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } function deserializeGoogleCloudRunV2Overrides(data: any): GoogleCloudRunV2Overrides { return { ...data, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } /** * Probe describes a health check to be performed against a container to * determine whether it is alive or ready to receive traffic. */ export interface GoogleCloudRunV2Probe { /** * Optional. Minimum consecutive failures for the probe to be considered * failed after having succeeded. Defaults to 3. Minimum value is 1. */ failureThreshold?: number; /** * Optional. GRPC specifies an action involving a gRPC port. Exactly one of * httpGet, tcpSocket, or grpc must be specified. */ grpc?: GoogleCloudRunV2GRPCAction; /** * Optional. HTTPGet specifies the http request to perform. Exactly one of * httpGet, tcpSocket, or grpc must be specified. */ httpGet?: GoogleCloudRunV2HTTPGetAction; /** * Optional. Number of seconds after the container has started before the * probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum * value for liveness probe is 3600. Maximum value for startup probe is 240. */ initialDelaySeconds?: number; /** * Optional. How often (in seconds) to perform the probe. Default to 10 * seconds. Minimum value is 1. Maximum value for liveness probe is 3600. * Maximum value for startup probe is 240. Must be greater or equal than * timeout_seconds. */ periodSeconds?: number; /** * Optional. TCPSocket specifies an action involving a TCP port. Exactly one * of httpGet, tcpSocket, or grpc must be specified. */ tcpSocket?: GoogleCloudRunV2TCPSocketAction; /** * Optional. Number of seconds after which the probe times out. Defaults to 1 * second. Minimum value is 1. Maximum value is 3600. Must be smaller than * period_seconds. */ timeoutSeconds?: number; } /** * ResourceRequirements describes the compute resource requirements. */ export interface GoogleCloudRunV2ResourceRequirements { /** * Determines whether CPU is only allocated during requests (true by * default). However, if ResourceRequirements is set, the caller must * explicitly set this field to true to preserve the default behavior. */ cpuIdle?: boolean; /** * Only `memory` and `cpu` keys in the map are supported. Notes: * The only * supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires * at least 2Gi of memory. For more information, go to * https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' * values and syntax, go to * https://cloud.google.com/run/docs/configuring/memory-limits */ limits?: { [key: string]: string }; /** * Determines whether CPU should be boosted on startup of a new container * instance above the requested CPU threshold, this can help reduce cold-start * latency. */ startupCpuBoost?: boolean; } /** * A Revision is an immutable snapshot of code and configuration. A Revision * references a container image. Revisions are only created by updates to its * parent Service. */ export interface GoogleCloudRunV2Revision { /** * Output only. Unstructured key value map that may be set by external tools * to store and arbitrary metadata. They are not queryable and should be * preserved when modifying objects. */ readonly annotations?: { [key: string]: string }; /** * Output only. The Condition of this Revision, containing its readiness * status, and detailed error information in case it did not reach a serving * state. */ readonly conditions?: GoogleCloudRunV2Condition[]; /** * Holds the single container that defines the unit of execution for this * Revision. */ containers?: GoogleCloudRunV2Container[]; /** * Output only. The creation time. */ readonly createTime?: Date; /** * Output only. For a deleted resource, the deletion time. It is only * populated as a response to a Delete request. */ readonly deleteTime?: Date; /** * A reference to a customer managed encryption key (CMEK) to use to encrypt * this container image. For more information, go to * https://cloud.google.com/run/docs/securing/using-cmek */ encryptionKey?: string; /** * The action to take if the encryption key is revoked. */ encryptionKeyRevocationAction?: | "ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED" | "PREVENT_NEW" | "SHUTDOWN"; /** * If encryption_key_revocation_action is SHUTDOWN, the duration before * shutting down all instances. The minimum increment is 1 hour. */ encryptionKeyShutdownDuration?: number /* Duration */; /** * Output only. A system-generated fingerprint for this version of the * resource. May be used to detect modification conflict during updates. */ readonly etag?: string; /** * The execution environment being used to host this Revision. */ executionEnvironment?: | "EXECUTION_ENVIRONMENT_UNSPECIFIED" | "EXECUTION_ENVIRONMENT_GEN1" | "EXECUTION_ENVIRONMENT_GEN2"; /** * Output only. For a deleted resource, the time after which it will be * permamently deleted. It is only populated as a response to a Delete * request. */ readonly expireTime?: Date; /** * Output only. A number that monotonically increases every time the user * modifies the desired state. */ readonly generation?: bigint; /** * Output only. 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. */ readonly labels?: { [key: string]: string }; /** * The least stable launch stage needed to create this resource, as defined * by [Google Cloud Platform Launch * Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports * `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used * as input. For example, if ALPHA was provided as input in the parent * resource, but only BETA and GA-level features are were, this field will be * BETA. */ launchStage?: | "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"; /** * Output only. The Google Console URI to obtain logs for the Revision. */ readonly logUri?: string; /** * Sets the maximum number of requests that each serving instance can * receive. */ maxInstanceRequestConcurrency?: number; /** * Output only. The unique name of this Revision. */ readonly name?: string; /** * The node selector for the revision. */ nodeSelector?: GoogleCloudRunV2NodeSelector; /** * Output only. The generation of this Revision currently serving traffic. * See comments in `reconciling` for additional information on reconciliation * process in Cloud Run. */ readonly observedGeneration?: bigint; /** * Output only. Indicates whether the resource's reconciliation is still in * progress. See comments in `Service.reconciling` for additional information * on reconciliation process in Cloud Run. */ readonly reconciling?: boolean; /** * Output only. Reserved for future use. */ readonly satisfiesPzs?: boolean; /** * Scaling settings for this revision. */ scaling?: GoogleCloudRunV2RevisionScaling; /** * Output only. The current effective scaling settings for the revision. */ readonly scalingStatus?: GoogleCloudRunV2RevisionScalingStatus; /** * Output only. The name of the parent service. */ readonly service?: string; /** * Email address of the IAM service account associated with the revision of * the service. The service account represents the identity of the running * revision, and determines what permissions the revision has. */ serviceAccount?: string; /** * Enables service mesh connectivity. */ serviceMesh?: GoogleCloudRunV2ServiceMesh; /** * Enable session affinity. */ sessionAffinity?: boolean; /** * Max allowed time for an instance to respond to a request. */ timeout?: number /* Duration */; /** * Output only. Server assigned unique identifier for the Revision. The value * is a UUID4 string and guaranteed to remain unchanged until the resource is * deleted. */ readonly uid?: string; /** * Output only. The last-modified time. */ readonly updateTime?: Date; /** * A list of Volumes to make available to containers. */ volumes?: GoogleCloudRunV2Volume[]; /** * VPC Access configuration for this Revision. For more information, visit * https://cloud.google.com/run/docs/configuring/connecting-vpc. */ vpcAccess?: GoogleCloudRunV2VpcAccess; } function serializeGoogleCloudRunV2Revision(data: any): GoogleCloudRunV2Revision { return { ...data, encryptionKeyShutdownDuration: data["encryptionKeyShutdownDuration"] !== undefined ? data["encryptionKeyShutdownDuration"] : undefined, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } function deserializeGoogleCloudRunV2Revision(data: any): GoogleCloudRunV2Revision { return { ...data, conditions: data["conditions"] !== undefined ? data["conditions"].map((item: any) => (deserializeGoogleCloudRunV2Condition(item))) : undefined, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, deleteTime: data["deleteTime"] !== undefined ? new Date(data["deleteTime"]) : undefined, encryptionKeyShutdownDuration: data["encryptionKeyShutdownDuration"] !== undefined ? data["encryptionKeyShutdownDuration"] : undefined, expireTime: data["expireTime"] !== undefined ? new Date(data["expireTime"]) : undefined, generation: data["generation"] !== undefined ? BigInt(data["generation"]) : undefined, observedGeneration: data["observedGeneration"] !== undefined ? BigInt(data["observedGeneration"]) : undefined, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, updateTime: data["updateTime"] !== undefined ? new Date(data["updateTime"]) : undefined, }; } /** * Settings for revision-level scaling settings. */ export interface GoogleCloudRunV2RevisionScaling { /** * Optional. Maximum number of serving instances that this resource should * have. When unspecified, the field is set to the server default value of * 100. For more information see * https://cloud.google.com/run/docs/configuring/max-instances */ maxInstanceCount?: number; /** * Optional. Minimum number of serving instances that this resource should * have. */ minInstanceCount?: number; } /** * Effective settings for the current revision */ export interface GoogleCloudRunV2RevisionScalingStatus { /** * The current number of min instances provisioned for this revision. */ desiredMinInstanceCount?: number; } /** * RevisionTemplate describes the data a revision should have when created from * a template. */ export interface GoogleCloudRunV2RevisionTemplate { /** * Optional. Unstructured key value map that may be set by external tools to * store and arbitrary metadata. They are not queryable and should be * preserved when modifying objects. Cloud Run API v2 does not support * annotations with `run.googleapis.com`, `cloud.googleapis.com`, * `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they * will be rejected. All system annotations in v1 now have a corresponding * field in v2 RevisionTemplate. This field follows Kubernetes annotations' * namespacing, limits, and rules. */ annotations?: { [key: string]: string }; /** * Holds the single container that defines the unit of execution for this * Revision. */ containers?: GoogleCloudRunV2Container[]; /** * A reference to a customer managed encryption key (CMEK) to use to encrypt * this container image. For more information, go to * https://cloud.google.com/run/docs/securing/using-cmek */ encryptionKey?: string; /** * Optional. The action to take if the encryption key is revoked. */ encryptionKeyRevocationAction?: | "ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED" | "PREVENT_NEW" | "SHUTDOWN"; /** * Optional. If encryption_key_revocation_action is SHUTDOWN, the duration * before shutting down all instances. The minimum increment is 1 hour. */ encryptionKeyShutdownDuration?: number /* Duration */; /** * Optional. The sandbox environment to host this Revision. */ executionEnvironment?: | "EXECUTION_ENVIRONMENT_UNSPECIFIED" | "EXECUTION_ENVIRONMENT_GEN1" | "EXECUTION_ENVIRONMENT_GEN2"; /** * Optional. Disables health checking containers during deployment. */ healthCheckDisabled?: boolean; /** * Optional. 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 RevisionTemplate. */ labels?: { [key: string]: string }; /** * Optional. Sets the maximum number of requests that each serving instance * can receive. If not specified or 0, concurrency defaults to 80 when * requested `CPU >= 1` and defaults to 1 when requested `CPU < 1`. */ maxInstanceRequestConcurrency?: number; /** * Optional. The node selector for the revision template. */ nodeSelector?: GoogleCloudRunV2NodeSelector; /** * Optional. The unique name for the revision. If this field is omitted, it * will be automatically generated based on the Service name. */ revision?: string; /** * Optional. Scaling settings for this Revision. */ scaling?: GoogleCloudRunV2RevisionScaling; /** * Optional. Email address of the IAM service account associated with the * revision of the service. The service account represents the identity of the * running revision, and determines what permissions the revision has. If not * provided, the revision will use the project's default service account. */ serviceAccount?: string; /** * Optional. Enables service mesh connectivity. */ serviceMesh?: GoogleCloudRunV2ServiceMesh; /** * Optional. Enable session affinity. */ sessionAffinity?: boolean; /** * Optional. Max allowed time for an instance to respond to a request. */ timeout?: number /* Duration */; /** * Optional. A list of Volumes to make available to containers. */ volumes?: GoogleCloudRunV2Volume[]; /** * Optional. VPC Access configuration to use for this Revision. For more * information, visit * https://cloud.google.com/run/docs/configuring/connecting-vpc. */ vpcAccess?: GoogleCloudRunV2VpcAccess; } function serializeGoogleCloudRunV2RevisionTemplate(data: any): GoogleCloudRunV2RevisionTemplate { return { ...data, encryptionKeyShutdownDuration: data["encryptionKeyShutdownDuration"] !== undefined ? data["encryptionKeyShutdownDuration"] : undefined, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } function deserializeGoogleCloudRunV2RevisionTemplate(data: any): GoogleCloudRunV2RevisionTemplate { return { ...data, encryptionKeyShutdownDuration: data["encryptionKeyShutdownDuration"] !== undefined ? data["encryptionKeyShutdownDuration"] : undefined, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } /** * Request message to create a new Execution of a Job. */ export interface GoogleCloudRunV2RunJobRequest { /** * A system-generated fingerprint for this version of the resource. May be * used to detect modification conflict during updates. */ etag?: string; /** * Overrides specification for a given execution of a job. If provided, * overrides will be applied to update the execution or task spec. */ overrides?: GoogleCloudRunV2Overrides; /** * Indicates that the request should be validated without actually deleting * any resources. */ validateOnly?: boolean; } function serializeGoogleCloudRunV2RunJobRequest(data: any): GoogleCloudRunV2RunJobRequest { return { ...data, overrides: data["overrides"] !== undefined ? serializeGoogleCloudRunV2Overrides(data["overrides"]) : undefined, }; } function deserializeGoogleCloudRunV2RunJobRequest(data: any): GoogleCloudRunV2RunJobRequest { return { ...data, overrides: data["overrides"] !== undefined ? deserializeGoogleCloudRunV2Overrides(data["overrides"]) : undefined, }; } /** * SecretEnvVarSource represents a source for the value of an EnvVar. */ export interface GoogleCloudRunV2SecretKeySelector { /** * Required. The name of the secret in Cloud Secret Manager. Format: * {secret_name} if the secret is in the same project. * projects/{project}/secrets/{secret_name} if the secret is in a different * project. */ secret?: string; /** * The Cloud Secret Manager secret version. Can be 'latest' for the latest * version, an integer for a specific version, or a version alias. */ version?: string; } /** * The secret's value will be presented as the content of a file whose name is * defined in the item path. If no items are defined, the name of the file is * the secret. */ export interface GoogleCloudRunV2SecretVolumeSource { /** * Integer representation of mode bits to use on created files by default. * Must be a value between 0000 and 0777 (octal), defaulting to 0444. * Directories within the path are not affected by this setting. Notes * * Internally, a umask of 0222 will be applied to any non-zero value. * This * is an integer representation of the mode bits. So, the octal integer value * should look exactly as the chmod numeric notation with a leading zero. Some * examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). * For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * * This might be in conflict with other options that affect the file mode, * like fsGroup, and the result can be other mode bits set. This might be in * conflict with other options that affect the file mode, like fsGroup, and as * a result, other mode bits could be set. */ defaultMode?: number; /** * If unspecified, the volume will expose a file whose name is the secret, * relative to VolumeMount.mount_path. If specified, the key will be used as * the version to fetch from Cloud Secret Manager and the path will be the * name of the file exposed in the volume. When items are defined, they must * specify a path and a version. */ items?: GoogleCloudRunV2VersionToPath[]; /** * Required. The name of the secret in Cloud Secret Manager. Format: {secret} * if the secret is in the same project. projects/{project}/secrets/{secret} * if the secret is in a different project. */ secret?: string; } /** * Service acts as a top-level container that manages a set of configurations * and revision templates which implement a network service. Service exists to * provide a singular abstraction which can be access controlled, reasoned * about, and which encapsulates software lifecycle decisions such as rollout * policy and team resource ownership. */ export interface GoogleCloudRunV2Service { /** * Optional. Unstructured key value map that may be set by external tools to * store and arbitrary metadata. They are not queryable and should be * preserved when modifying objects. Cloud Run API v2 does not support * annotations with `run.googleapis.com`, `cloud.googleapis.com`, * `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they * will be rejected in new resources. All system annotations in v1 now have a * corresponding field in v2 Service. This field follows Kubernetes * annotations' namespacing, limits, and rules. */ annotations?: { [key: string]: string }; /** * Optional. Settings for the Binary Authorization feature. */ binaryAuthorization?: GoogleCloudRunV2BinaryAuthorization; /** * Arbitrary identifier for the API client. */ client?: string; /** * Arbitrary version identifier for the API client. */ clientVersion?: string; /** * Output only. The Conditions of all other associated sub-resources. They * contain additional diagnostics information in case the Service does not * reach its Serving state. See comments in `reconciling` for additional * information on reconciliation process in Cloud Run. */ readonly conditions?: GoogleCloudRunV2Condition[]; /** * Output only. The creation time. */ readonly createTime?: Date; /** * Output only. Email address of the authenticated creator. */ readonly creator?: string; /** * One or more custom audiences that you want this service to support. * Specify each custom audience as the full URL in a string. The custom * audiences are encoded in the token and used to authenticate requests. For * more information, see * https://cloud.google.com/run/docs/configuring/custom-audiences. */ customAudiences?: string[]; /** * Optional. Disables public resolution of the default URI of this service. */ defaultUriDisabled?: boolean; /** * Output only. The deletion time. It is only populated as a response to a * Delete request. */ readonly deleteTime?: Date; /** * User-provided description of the Service. This field currently has a * 512-character limit. */ description?: string; /** * Output only. A system-generated fingerprint for this version of the * resource. May be used to detect modification conflict during updates. */ readonly etag?: string; /** * Output only. For a deleted resource, the time after which it will be * permamently deleted. */ readonly expireTime?: Date; /** * Output only. A number that monotonically increases every time the user * modifies the desired state. Please note that unlike v1, this is an int64 * value. As with most Google APIs, its JSON representation will be a `string` * instead of an `integer`. */ readonly generation?: bigint; /** * Optional. Provides the ingress settings for this Service. On output, * returns the currently observed ingress settings, or * INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. */ ingress?: | "INGRESS_TRAFFIC_UNSPECIFIED" | "INGRESS_TRAFFIC_ALL" | "INGRESS_TRAFFIC_INTERNAL_ONLY" | "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER" | "INGRESS_TRAFFIC_NONE"; /** * Optional. Disables IAM permission check for run.routes.invoke for callers * of this service. This feature is available by invitation only. For more * information, visit * https://cloud.google.com/run/docs/securing/managing-access#invoker_check. */ invokerIamDisabled?: boolean; /** * Optional. 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 Service. */ labels?: { [key: string]: string }; /** * Output only. Email address of the last authenticated modifier. */ readonly lastModifier?: string; /** * Output only. Name of the last created revision. See comments in * `reconciling` for additional information on reconciliation process in Cloud * Run. */ readonly latestCreatedRevision?: string; /** * Output only. Name of the latest revision that is serving traffic. See * comments in `reconciling` for additional information on reconciliation * process in Cloud Run. */ readonly latestReadyRevision?: string; /** * Optional. The launch stage as defined by [Google Cloud Platform Launch * Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports * `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the * launch stage to a preview stage on input to allow use of preview features * in that stage. On read (or output), describes whether the resource uses * preview features. For example, if ALPHA is provided as input, but only BETA * and GA-level features are used, this field will be BETA on output. */ launchStage?: | "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"; /** * The fully qualified name of this Service. In CreateServiceRequest, this * field is ignored, and instead composed from CreateServiceRequest.parent and * CreateServiceRequest.service_id. Format: * projects/{project}/locations/{location}/services/{service_id} */ name?: string; /** * Output only. The generation of this Service currently serving traffic. See * comments in `reconciling` for additional information on reconciliation * process in Cloud Run. Please note that unlike v1, this is an int64 value. * As with most Google APIs, its JSON representation will be a `string` * instead of an `integer`. */ readonly observedGeneration?: bigint; /** * Output only. Returns true if the Service is currently being acted upon by * the system to bring it into the desired state. When a new Service is * created, or an existing one is updated, Cloud Run will asynchronously * perform all necessary steps to bring the Service to the desired serving * state. This process is called reconciliation. While reconciliation is in * process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, * and `uri` will have transient values that might mismatch the intended * state: Once reconciliation is over (and this field is false), there are two * possible outcomes: reconciliation succeeded and the serving state matches * the Service, or there was an error, and reconciliation failed. This state * can be found in `terminal_condition.state`. If reconciliation succeeded, * the following fields will match: `traffic` and `traffic_statuses`, * `observed_generation` and `generation`, `latest_ready_revision` and * `latest_created_revision`. If reconciliation failed, `traffic_statuses`, * `observed_generation`, and `latest_ready_revision` will have the state of * the last serving revision, or empty for newly created Services. Additional * information on the failure can be found in `terminal_condition` and * `conditions`. */ readonly reconciling?: boolean; /** * Output only. Reserved for future use. */ readonly satisfiesPzs?: boolean; /** * Optional. Specifies service-level scaling settings */ scaling?: GoogleCloudRunV2ServiceScaling; /** * Required. The template used to create revisions for this Service. */ template?: GoogleCloudRunV2RevisionTemplate; /** * Output only. The Condition of this Service, containing its readiness * status, and detailed error information in case it did not reach a serving * state. See comments in `reconciling` for additional information on * reconciliation process in Cloud Run. */ readonly terminalCondition?: GoogleCloudRunV2Condition; /** * Optional. Specifies how to distribute traffic over a collection of * Revisions belonging to the Service. If traffic is empty or not provided, * defaults to 100% traffic to the latest `Ready` Revision. */ traffic?: GoogleCloudRunV2TrafficTarget[]; /** * Output only. Detailed status information for corresponding traffic * targets. See comments in `reconciling` for additional information on * reconciliation process in Cloud Run. */ readonly trafficStatuses?: GoogleCloudRunV2TrafficTargetStatus[]; /** * Output only. Server assigned unique identifier for the trigger. The value * is a UUID4 string and guaranteed to remain unchanged until the resource is * deleted. */ readonly uid?: string; /** * Output only. The last-modified time. */ readonly updateTime?: Date; /** * Output only. The main URI in which this Service is serving traffic. */ readonly uri?: string; /** * Output only. All URLs serving traffic for this Service. */ readonly urls?: string[]; } function serializeGoogleCloudRunV2Service(data: any): GoogleCloudRunV2Service { return { ...data, template: data["template"] !== undefined ? serializeGoogleCloudRunV2RevisionTemplate(data["template"]) : undefined, }; } function deserializeGoogleCloudRunV2Service(data: any): GoogleCloudRunV2Service { return { ...data, conditions: data["conditions"] !== undefined ? data["conditions"].map((item: any) => (deserializeGoogleCloudRunV2Condition(item))) : undefined, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, deleteTime: data["deleteTime"] !== undefined ? new Date(data["deleteTime"]) : undefined, expireTime: data["expireTime"] !== undefined ? new Date(data["expireTime"]) : undefined, generation: data["generation"] !== undefined ? BigInt(data["generation"]) : undefined, observedGeneration: data["observedGeneration"] !== undefined ? BigInt(data["observedGeneration"]) : undefined, template: data["template"] !== undefined ? deserializeGoogleCloudRunV2RevisionTemplate(data["template"]) : undefined, terminalCondition: data["terminalCondition"] !== undefined ? deserializeGoogleCloudRunV2Condition(data["terminalCondition"]) : undefined, updateTime: data["updateTime"] !== undefined ? new Date(data["updateTime"]) : undefined, }; } /** * Settings for Cloud Service Mesh. For more information see * https://cloud.google.com/service-mesh/docs/overview. */ export interface GoogleCloudRunV2ServiceMesh { /** * The Mesh resource name. Format: * `projects/{project}/locations/global/meshes/{mesh}`, where `{project}` can * be project id or number. */ mesh?: string; } /** * Scaling settings applied at the service level rather than at the revision * level. */ export interface GoogleCloudRunV2ServiceScaling { /** * Optional. total min instances for the service. This number of instances is * divided among all revisions with specified traffic based on the percent of * traffic they are receiving. */ minInstanceCount?: number; /** * Optional. The scaling mode for the service. */ scalingMode?: | "SCALING_MODE_UNSPECIFIED" | "AUTOMATIC" | "MANUAL"; } /** * Location of the source in an archive file in Google Cloud Storage. */ export interface GoogleCloudRunV2StorageSource { /** * Required. Google Cloud Storage bucket containing the source (see [Bucket * Name * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). */ bucket?: string; /** * Optional. Google Cloud Storage generation for the object. If the * generation is omitted, the latest generation will be used. */ generation?: bigint; /** * Required. Google Cloud Storage object containing the source. This object * must be a gzipped archive file (`.tar.gz`) containing source to build. */ object?: string; } function serializeGoogleCloudRunV2StorageSource(data: any): GoogleCloudRunV2StorageSource { return { ...data, generation: data["generation"] !== undefined ? String(data["generation"]) : undefined, }; } function deserializeGoogleCloudRunV2StorageSource(data: any): GoogleCloudRunV2StorageSource { return { ...data, generation: data["generation"] !== undefined ? BigInt(data["generation"]) : undefined, }; } /** * Request message for submitting a Build. */ export interface GoogleCloudRunV2SubmitBuildRequest { /** * Build the source using Buildpacks. */ buildpackBuild?: GoogleCloudRunV2BuildpacksBuild; /** * Build the source using Docker. This means the source has a Dockerfile. */ dockerBuild?: GoogleCloudRunV2DockerBuild; /** * Required. Artifact Registry URI to store the built image. */ imageUri?: string; /** * Optional. The service account to use for the build. If not set, the * default Cloud Build service account for the project will be used. */ serviceAccount?: string; /** * Required. Source for the build. */ storageSource?: GoogleCloudRunV2StorageSource; /** * Optional. Additional tags to annotate the build. */ tags?: string[]; /** * Optional. Name of the Cloud Build Custom Worker Pool that should be used * to build the function. The format of this field is * `projects/{project}/locations/{region}/workerPools/{workerPool}` where * `{project}` and `{region}` are the project id and region respectively where * the worker pool is defined and `{workerPool}` is the short name of the * worker pool. */ workerPool?: string; } function serializeGoogleCloudRunV2SubmitBuildRequest(data: any): GoogleCloudRunV2SubmitBuildRequest { return { ...data, storageSource: data["storageSource"] !== undefined ? serializeGoogleCloudRunV2StorageSource(data["storageSource"]) : undefined, }; } function deserializeGoogleCloudRunV2SubmitBuildRequest(data: any): GoogleCloudRunV2SubmitBuildRequest { return { ...data, storageSource: data["storageSource"] !== undefined ? deserializeGoogleCloudRunV2StorageSource(data["storageSource"]) : undefined, }; } /** * Response message for submitting a Build. */ export interface GoogleCloudRunV2SubmitBuildResponse { /** * URI of the base builder image in Artifact Registry being used in the * build. Used to opt into automatic base image updates. */ baseImageUri?: string; /** * Warning message for the base image. */ baseImageWarning?: string; /** * Cloud Build operation to be polled via CloudBuild API. */ buildOperation?: GoogleLongrunningOperation; } /** * Task represents a single run of a container to completion. */ export interface GoogleCloudRunV2Task { /** * Output only. Unstructured key value map that may be set by external tools * to store and arbitrary metadata. They are not queryable and should be * preserved when modifying objects. */ readonly annotations?: { [key: string]: string }; /** * Output only. Represents time when the Task was completed. It is not * guaranteed to be set in happens-before order across separate operations. */ readonly completionTime?: Date; /** * Output only. The Condition of this Task, containing its readiness status, * and detailed error information in case it did not reach the desired state. */ readonly conditions?: GoogleCloudRunV2Condition[]; /** * Holds the single container that defines the unit of execution for this * task. */ containers?: GoogleCloudRunV2Container[]; /** * Output only. Represents time when the task was created by the system. It * is not guaranteed to be set in happens-before order across separate * operations. */ readonly createTime?: Date; /** * Output only. For a deleted resource, the deletion time. It is only * populated as a response to a Delete request. */ readonly deleteTime?: Date; /** * Output only. A reference to a customer managed encryption key (CMEK) to * use to encrypt this container image. For more information, go to * https://cloud.google.com/run/docs/securing/using-cmek */ readonly encryptionKey?: string; /** * Output only. A system-generated fingerprint for this version of the * resource. May be used to detect modification conflict during updates. */ readonly etag?: string; /** * Output only. The name of the parent Execution. */ readonly execution?: string; /** * The execution environment being used to host this Task. */ executionEnvironment?: | "EXECUTION_ENVIRONMENT_UNSPECIFIED" | "EXECUTION_ENVIRONMENT_GEN1" | "EXECUTION_ENVIRONMENT_GEN2"; /** * Output only. For a deleted resource, the time after which it will be * permamently deleted. It is only populated as a response to a Delete * request. */ readonly expireTime?: Date; /** * Output only. A number that monotonically increases every time the user * modifies the desired state. */ readonly generation?: bigint; /** * Output only. Index of the Task, unique per execution, and beginning at 0. */ readonly index?: number; /** * Output only. The name of the parent Job. */ readonly job?: string; /** * Output only. 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 */ readonly labels?: { [key: string]: string }; /** * Output only. Result of the last attempt of this Task. */ readonly lastAttemptResult?: GoogleCloudRunV2TaskAttemptResult; /** * Output only. URI where logs for this execution can be found in Cloud * Console. */ readonly logUri?: string; /** * Number of retries allowed per Task, before marking this Task failed. */ maxRetries?: number; /** * Output only. The unique name of this Task. */ readonly name?: string; /** * Output only. The generation of this Task. See comments in * `Job.reconciling` for additional information on reconciliation process in * Cloud Run. */ readonly observedGeneration?: bigint; /** * Output only. Indicates whether the resource's reconciliation is still in * progress. See comments in `Job.reconciling` for additional information on * reconciliation process in Cloud Run. */ readonly reconciling?: boolean; /** * Output only. The number of times this Task was retried. Tasks are retried * when they fail up to the maxRetries limit. */ readonly retried?: number; /** * Output only. Reserved for future use. */ readonly satisfiesPzs?: boolean; /** * Output only. Represents time when the task was scheduled to run by the * system. It is not guaranteed to be set in happens-before order across * separate operations. */ readonly scheduledTime?: Date; /** * Email address of the IAM service account associated with the Task of a * Job. The service account represents the identity of the running task, and * determines what permissions the task has. If not provided, the task will * use the project's default service account. */ serviceAccount?: string; /** * Output only. Represents time when the task started to run. It is not * guaranteed to be set in happens-before order across separate operations. */ readonly startTime?: Date; /** * Max allowed time duration the Task may be active before the system will * actively try to mark it failed and kill associated containers. This applies * per attempt of a task, meaning each retry can run for the full timeout. */ timeout?: number /* Duration */; /** * Output only. Server assigned unique identifier for the Task. The value is * a UUID4 string and guaranteed to remain unchanged until the resource is * deleted. */ readonly uid?: string; /** * Output only. The last-modified time. */ readonly updateTime?: Date; /** * A list of Volumes to make available to containers. */ volumes?: GoogleCloudRunV2Volume[]; /** * Output only. VPC Access configuration to use for this Task. For more * information, visit * https://cloud.google.com/run/docs/configuring/connecting-vpc. */ readonly vpcAccess?: GoogleCloudRunV2VpcAccess; } function serializeGoogleCloudRunV2Task(data: any): GoogleCloudRunV2Task { return { ...data, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } function deserializeGoogleCloudRunV2Task(data: any): GoogleCloudRunV2Task { return { ...data, completionTime: data["completionTime"] !== undefined ? new Date(data["completionTime"]) : undefined, conditions: data["conditions"] !== undefined ? data["conditions"].map((item: any) => (deserializeGoogleCloudRunV2Condition(item))) : undefined, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, deleteTime: data["deleteTime"] !== undefined ? new Date(data["deleteTime"]) : undefined, expireTime: data["expireTime"] !== undefined ? new Date(data["expireTime"]) : undefined, generation: data["generation"] !== undefined ? BigInt(data["generation"]) : undefined, observedGeneration: data["observedGeneration"] !== undefined ? BigInt(data["observedGeneration"]) : undefined, scheduledTime: data["scheduledTime"] !== undefined ? new Date(data["scheduledTime"]) : undefined, startTime: data["startTime"] !== undefined ? new Date(data["startTime"]) : undefined, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, updateTime: data["updateTime"] !== undefined ? new Date(data["updateTime"]) : undefined, }; } /** * Result of a task attempt. */ export interface GoogleCloudRunV2TaskAttemptResult { /** * Output only. The exit code of this attempt. This may be unset if the * container was unable to exit cleanly with a code due to some other failure. * See status field for possible failure details. */ readonly exitCode?: number; /** * Output only. The status of this attempt. If the status code is OK, then * the attempt succeeded. */ readonly status?: GoogleRpcStatus; } /** * TaskTemplate describes the data a task should have when created from a * template. */ export interface GoogleCloudRunV2TaskTemplate { /** * Holds the single container that defines the unit of execution for this * task. */ containers?: GoogleCloudRunV2Container[]; /** * A reference to a customer managed encryption key (CMEK) to use to encrypt * this container image. For more information, go to * https://cloud.google.com/run/docs/securing/using-cmek */ encryptionKey?: string; /** * Optional. The execution environment being used to host this Task. */ executionEnvironment?: | "EXECUTION_ENVIRONMENT_UNSPECIFIED" | "EXECUTION_ENVIRONMENT_GEN1" | "EXECUTION_ENVIRONMENT_GEN2"; /** * Number of retries allowed per Task, before marking this Task failed. * Defaults to 3. */ maxRetries?: number; /** * Optional. Email address of the IAM service account associated with the * Task of a Job. The service account represents the identity of the running * task, and determines what permissions the task has. If not provided, the * task will use the project's default service account. */ serviceAccount?: string; /** * Optional. Max allowed time duration the Task may be active before the * system will actively try to mark it failed and kill associated containers. * This applies per attempt of a task, meaning each retry can run for the full * timeout. Defaults to 600 seconds. */ timeout?: number /* Duration */; /** * Optional. A list of Volumes to make available to containers. */ volumes?: GoogleCloudRunV2Volume[]; /** * Optional. VPC Access configuration to use for this Task. For more * information, visit * https://cloud.google.com/run/docs/configuring/connecting-vpc. */ vpcAccess?: GoogleCloudRunV2VpcAccess; } function serializeGoogleCloudRunV2TaskTemplate(data: any): GoogleCloudRunV2TaskTemplate { return { ...data, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } function deserializeGoogleCloudRunV2TaskTemplate(data: any): GoogleCloudRunV2TaskTemplate { return { ...data, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } /** * TCPSocketAction describes an action based on opening a socket */ export interface GoogleCloudRunV2TCPSocketAction { /** * Optional. Port number to access on the container. Must be in the range 1 * to 65535. If not specified, defaults to the exposed port of the container, * which is the value of container.ports[0].containerPort. */ port?: number; } /** * Holds a single traffic routing entry for the Service. Allocations can be * done to a specific Revision name, or pointing to the latest Ready Revision. */ export interface GoogleCloudRunV2TrafficTarget { /** * Specifies percent of the traffic to this Revision. This defaults to zero * if unspecified. */ percent?: number; /** * Revision to which to send this portion of traffic, if traffic allocation * is by revision. */ revision?: string; /** * Indicates a string to be part of the URI to exclusively reference this * target. */ tag?: string; /** * The allocation type for this traffic target. */ type?: | "TRAFFIC_TARGET_ALLOCATION_TYPE_UNSPECIFIED" | "TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST" | "TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION"; } /** * Represents the observed state of a single `TrafficTarget` entry. */ export interface GoogleCloudRunV2TrafficTargetStatus { /** * Specifies percent of the traffic to this Revision. */ percent?: number; /** * Revision to which this traffic is sent. */ revision?: string; /** * Indicates the string used in the URI to exclusively reference this target. */ tag?: string; /** * The allocation type for this traffic target. */ type?: | "TRAFFIC_TARGET_ALLOCATION_TYPE_UNSPECIFIED" | "TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST" | "TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION"; /** * Displays the target URI. */ uri?: string; } /** * VersionToPath maps a specific version of a secret to a relative file to * mount to, relative to VolumeMount's mount_path. */ export interface GoogleCloudRunV2VersionToPath { /** * Integer octal mode bits to use on this file, must be a value between 01 * and 0777 (octal). If 0 or not set, the Volume's default mode will be used. * Notes * Internally, a umask of 0222 will be applied to any non-zero value. * * This is an integer representation of the mode bits. So, the octal integer * value should look exactly as the chmod numeric notation with a leading * zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 * (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 * (base-10). * This might be in conflict with other options that affect the * file mode, like fsGroup, and the result can be other mode bits set. */ mode?: number; /** * Required. The relative path of the secret in the container. */ path?: string; /** * The Cloud Secret Manager secret version. Can be 'latest' for the latest * value, or an integer or a secret alias for a specific version. */ version?: string; } /** * Volume represents a named volume in a container. */ export interface GoogleCloudRunV2Volume { /** * For Cloud SQL volumes, contains the specific instances that should be * mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more * information on how to connect Cloud SQL and Cloud Run. */ cloudSqlInstance?: GoogleCloudRunV2CloudSqlInstance; /** * Ephemeral storage used as a shared volume. */ emptyDir?: GoogleCloudRunV2EmptyDirVolumeSource; /** * Persistent storage backed by a Google Cloud Storage bucket. */ gcs?: GoogleCloudRunV2GCSVolumeSource; /** * Required. Volume's name. */ name?: string; /** * For NFS Voumes, contains the path to the nfs Volume */ nfs?: GoogleCloudRunV2NFSVolumeSource; /** * Secret represents a secret that should populate this volume. */ secret?: GoogleCloudRunV2SecretVolumeSource; } /** * VolumeMount describes a mounting of a Volume within a container. */ export interface GoogleCloudRunV2VolumeMount { /** * Required. Path within the container at which the volume should be mounted. * Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must * otherwise be `/cloudsql`. All instances defined in the Volume will be * available as `/cloudsql/[instance]`. For more information on Cloud SQL * volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run */ mountPath?: string; /** * Required. This must match the Name of a Volume. */ name?: string; } /** * VPC Access settings. For more information on sending traffic to a VPC * network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. */ export interface GoogleCloudRunV2VpcAccess { /** * VPC Access connector name. Format: * `projects/{project}/locations/{location}/connectors/{connector}`, where * `{project}` can be project id or number. For more information on sending * traffic to a VPC network via a connector, visit * https://cloud.google.com/run/docs/configuring/vpc-connectors. */ connector?: string; /** * Optional. Traffic VPC egress settings. If not provided, it defaults to * PRIVATE_RANGES_ONLY. */ egress?: | "VPC_EGRESS_UNSPECIFIED" | "ALL_TRAFFIC" | "PRIVATE_RANGES_ONLY"; /** * Optional. Direct VPC egress settings. Currently only single network * interface is supported. */ networkInterfaces?: GoogleCloudRunV2NetworkInterface[]; } /** * ApprovalConfig describes configuration for manual approval of a build. */ export interface GoogleDevtoolsCloudbuildV1ApprovalConfig { /** * Whether or not approval is needed. If this is set on a build, it will * become pending when created, and will need to be explicitly approved to * start. */ approvalRequired?: boolean; } /** * ApprovalResult describes the decision and associated metadata of a manual * approval of a build. */ export interface GoogleDevtoolsCloudbuildV1ApprovalResult { /** * Output only. The time when the approval decision was made. */ readonly approvalTime?: Date; /** * Output only. Email of the user that called the ApproveBuild API to approve * or reject a build at the time that the API was called. */ readonly approverAccount?: string; /** * Optional. An optional comment for this manual approval result. */ comment?: string; /** * Required. The decision of this manual approval. */ decision?: | "DECISION_UNSPECIFIED" | "APPROVED" | "REJECTED"; /** * Optional. An optional URL tied to this manual approval result. This field * is essentially the same as comment, except that it will be rendered by the * UI differently. An example use case is a link to an external job that * approved this Build. */ url?: string; } /** * Files in the workspace to upload to Cloud Storage upon successful completion * of all build steps. */ export interface GoogleDevtoolsCloudbuildV1ArtifactObjects { /** * Cloud Storage bucket and optional object path, in the form * "gs://bucket/path/to/somewhere/". (see [Bucket Name * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). * Files in the workspace matching any path pattern will be uploaded to Cloud * Storage with this location as a prefix. */ location?: string; /** * Path globs used to match files in the build's workspace. */ paths?: string[]; /** * Output only. Stores timing information for pushing all artifact objects. */ readonly timing?: GoogleDevtoolsCloudbuildV1TimeSpan; } /** * Artifacts produced by a build that should be uploaded upon successful * completion of all build steps. */ export interface GoogleDevtoolsCloudbuildV1Artifacts { /** * A list of images to be pushed upon the successful completion of all build * steps. The images will be pushed using the builder service account's * credentials. The digests of the pushed images will be stored in the Build * resource's results field. If any of the images fail to be pushed, the build * is marked FAILURE. */ images?: string[]; /** * A list of Maven artifacts to be uploaded to Artifact Registry upon * successful completion of all build steps. Artifacts in the workspace * matching specified paths globs will be uploaded to the specified Artifact * Registry repository using the builder service account's credentials. If any * artifacts fail to be pushed, the build is marked FAILURE. */ mavenArtifacts?: GoogleDevtoolsCloudbuildV1MavenArtifact[]; /** * A list of npm packages to be uploaded to Artifact Registry upon successful * completion of all build steps. Npm packages in the specified paths will be * uploaded to the specified Artifact Registry repository using the builder * service account's credentials. If any packages fail to be pushed, the build * is marked FAILURE. */ npmPackages?: GoogleDevtoolsCloudbuildV1NpmPackage[]; /** * A list of objects to be uploaded to Cloud Storage upon successful * completion of all build steps. Files in the workspace matching specified * paths globs will be uploaded to the specified Cloud Storage location using * the builder service account's credentials. The location and generation of * the uploaded objects will be stored in the Build resource's results field. * If any objects fail to be pushed, the build is marked FAILURE. */ objects?: GoogleDevtoolsCloudbuildV1ArtifactObjects; /** * A list of Python packages to be uploaded to Artifact Registry upon * successful completion of all build steps. The build service account * credentials will be used to perform the upload. If any objects fail to be * pushed, the build is marked FAILURE. */ pythonPackages?: GoogleDevtoolsCloudbuildV1PythonPackage[]; } /** * A build resource in the Cloud Build API. At a high level, a `Build` * describes where to find source code, how to build it (for example, the * builder image to run on the source), and where to store the built artifacts. * Fields can include the following variables, which will be expanded when the * build is created: - $PROJECT_ID: the project ID of the build. - * $PROJECT_NUMBER: the project number of the build. - $LOCATION: the * location/region of the build. - $BUILD_ID: the autogenerated ID of the build. * - $REPO_NAME: the source repository name specified by RepoSource. - * $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag * name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA * specified by RepoSource or resolved from the specified branch or tag. - * $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. */ export interface GoogleDevtoolsCloudbuildV1Build { /** * Output only. Describes this build's approval configuration, status, and * result. */ readonly approval?: GoogleDevtoolsCloudbuildV1BuildApproval; /** * Artifacts produced by the build that should be uploaded upon successful * completion of all build steps. */ artifacts?: GoogleDevtoolsCloudbuildV1Artifacts; /** * Secrets and secret environment variables. */ availableSecrets?: GoogleDevtoolsCloudbuildV1Secrets; /** * Output only. The ID of the `BuildTrigger` that triggered this build, if it * was triggered automatically. */ readonly buildTriggerId?: string; /** * Output only. Time at which the request to create the build was received. */ readonly createTime?: Date; /** * Output only. Contains information about the build when status=FAILURE. */ readonly failureInfo?: GoogleDevtoolsCloudbuildV1FailureInfo; /** * Output only. Time at which execution of the build was finished. The * difference between finish_time and start_time is the duration of the * build's execution. */ readonly finishTime?: Date; /** * Optional. Configuration for git operations. */ gitConfig?: GoogleDevtoolsCloudbuildV1GitConfig; /** * Output only. Unique identifier of the build. */ readonly id?: string; /** * A list of images to be pushed upon the successful completion of all build * steps. The images are pushed using the builder service account's * credentials. The digests of the pushed images will be stored in the `Build` * resource's results field. If any of the images fail to be pushed, the build * status is marked `FAILURE`. */ images?: string[]; /** * Cloud Storage bucket where logs should be written (see [Bucket Name * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). * Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. */ logsBucket?: string; /** * Output only. URL to logs for this build in Google Cloud Console. */ readonly logUrl?: string; /** * Output only. The 'Build' name with format: * `projects/{project}/locations/{location}/builds/{build}`, where {build} is * a unique identifier generated by the service. */ readonly name?: string; /** * Special options for this build. */ options?: GoogleDevtoolsCloudbuildV1BuildOptions; /** * Output only. ID of the project. */ readonly projectId?: string; /** * TTL in queue for this build. If provided and the build is enqueued longer * than this value, the build will expire and the build status will be * `EXPIRED`. The TTL starts ticking from create_time. */ queueTtl?: number /* Duration */; /** * Output only. Results of the build. */ readonly results?: GoogleDevtoolsCloudbuildV1Results; /** * Secrets to decrypt using Cloud Key Management Service. Note: Secret * Manager is the recommended technique for managing sensitive data with Cloud * Build. Use `available_secrets` to configure builds to access secrets from * Secret Manager. For instructions, see: * https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets */ secrets?: GoogleDevtoolsCloudbuildV1Secret[]; /** * IAM service account whose credentials will be used at build runtime. Must * be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT * can be email address or uniqueId of the service account. */ serviceAccount?: string; /** * Optional. The location of the source files to build. */ source?: GoogleDevtoolsCloudbuildV1Source; /** * Output only. A permanent fixed identifier for source. */ readonly sourceProvenance?: GoogleDevtoolsCloudbuildV1SourceProvenance; /** * Output only. Time at which execution of the build was started. */ readonly startTime?: Date; /** * Output only. Status of the build. */ readonly status?: | "STATUS_UNKNOWN" | "PENDING" | "QUEUED" | "WORKING" | "SUCCESS" | "FAILURE" | "INTERNAL_ERROR" | "TIMEOUT" | "CANCELLED" | "EXPIRED"; /** * Output only. Customer-readable message about the current status. */ readonly statusDetail?: string; /** * Required. The operations to be performed on the workspace. */ steps?: GoogleDevtoolsCloudbuildV1BuildStep[]; /** * Substitutions data for `Build` resource. */ substitutions?: { [key: string]: string }; /** * Tags for annotation of a `Build`. These are not docker tags. */ tags?: string[]; /** * Amount of time that this build should be allowed to run, to second * granularity. If this amount of time elapses, work on the build will cease * and the build status will be `TIMEOUT`. `timeout` starts ticking from * `startTime`. Default time is 60 minutes. */ timeout?: number /* Duration */; /** * Output only. Stores timing information for phases of the build. Valid keys * are: * BUILD: time to execute all build steps. * PUSH: time to push all * artifacts including docker images and non docker artifacts. * FETCHSOURCE: * time to fetch source. * SETUPBUILD: time to set up build. If the build does * not specify source or images, these keys will not be included. */ readonly timing?: { [key: string]: GoogleDevtoolsCloudbuildV1TimeSpan }; /** * Output only. Non-fatal problems encountered during the execution of the * build. */ readonly warnings?: GoogleDevtoolsCloudbuildV1Warning[]; } function serializeGoogleDevtoolsCloudbuildV1Build(data: any): GoogleDevtoolsCloudbuildV1Build { return { ...data, availableSecrets: data["availableSecrets"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1Secrets(data["availableSecrets"]) : undefined, options: data["options"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1BuildOptions(data["options"]) : undefined, queueTtl: data["queueTtl"] !== undefined ? data["queueTtl"] : undefined, secrets: data["secrets"] !== undefined ? data["secrets"].map((item: any) => (serializeGoogleDevtoolsCloudbuildV1Secret(item))) : undefined, source: data["source"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1Source(data["source"]) : undefined, steps: data["steps"] !== undefined ? data["steps"].map((item: any) => (serializeGoogleDevtoolsCloudbuildV1BuildStep(item))) : undefined, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1Build(data: any): GoogleDevtoolsCloudbuildV1Build { return { ...data, availableSecrets: data["availableSecrets"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1Secrets(data["availableSecrets"]) : undefined, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, finishTime: data["finishTime"] !== undefined ? new Date(data["finishTime"]) : undefined, options: data["options"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1BuildOptions(data["options"]) : undefined, queueTtl: data["queueTtl"] !== undefined ? data["queueTtl"] : undefined, results: data["results"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1Results(data["results"]) : undefined, secrets: data["secrets"] !== undefined ? data["secrets"].map((item: any) => (deserializeGoogleDevtoolsCloudbuildV1Secret(item))) : undefined, source: data["source"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1Source(data["source"]) : undefined, sourceProvenance: data["sourceProvenance"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1SourceProvenance(data["sourceProvenance"]) : undefined, startTime: data["startTime"] !== undefined ? new Date(data["startTime"]) : undefined, steps: data["steps"] !== undefined ? data["steps"].map((item: any) => (deserializeGoogleDevtoolsCloudbuildV1BuildStep(item))) : undefined, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, timing: data["timing"] !== undefined ? Object.fromEntries(Object.entries(data["timing"]).map(([k, v]: [string, any]) => ([k, deserializeGoogleDevtoolsCloudbuildV1TimeSpan(v)]))) : undefined, }; } /** * BuildApproval describes a build's approval configuration, state, and result. */ export interface GoogleDevtoolsCloudbuildV1BuildApproval { /** * Output only. Configuration for manual approval of this build. */ readonly config?: GoogleDevtoolsCloudbuildV1ApprovalConfig; /** * Output only. Result of manual approval for this Build. */ readonly result?: GoogleDevtoolsCloudbuildV1ApprovalResult; /** * Output only. The state of this build's approval. */ readonly state?: | "STATE_UNSPECIFIED" | "PENDING" | "APPROVED" | "REJECTED" | "CANCELLED"; } /** * Metadata for build operations. */ export interface GoogleDevtoolsCloudbuildV1BuildOperationMetadata { /** * The build that the operation is tracking. */ build?: GoogleDevtoolsCloudbuildV1Build; } function serializeGoogleDevtoolsCloudbuildV1BuildOperationMetadata(data: any): GoogleDevtoolsCloudbuildV1BuildOperationMetadata { return { ...data, build: data["build"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1Build(data["build"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1BuildOperationMetadata(data: any): GoogleDevtoolsCloudbuildV1BuildOperationMetadata { return { ...data, build: data["build"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1Build(data["build"]) : undefined, }; } /** * Optional arguments to enable specific features of builds. */ export interface GoogleDevtoolsCloudbuildV1BuildOptions { /** * Option to include built-in and custom substitutions as env variables for * all build steps. */ automapSubstitutions?: boolean; /** * Optional. Option to specify how default logs buckets are setup. */ defaultLogsBucketBehavior?: | "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED" | "REGIONAL_USER_OWNED_BUCKET" | "LEGACY_BUCKET"; /** * Requested disk size for the VM that runs the build. Note that this is * *NOT* "disk free"; some of the space will be used by the operating system * and build utilities. Also note that this is the minimum disk size that will * be allocated for the build -- the build may run with a larger disk than * requested. At present, the maximum disk size is 4000GB; builds that request * more than the maximum are rejected with an error. */ diskSizeGb?: bigint; /** * Option to specify whether or not to apply bash style string operations to * the substitutions. NOTE: this is always enabled for triggered builds and * cannot be overridden in the build configuration file. */ dynamicSubstitutions?: boolean; /** * A list of global environment variable definitions that will exist for all * build steps in this build. If a variable is defined in both globally and in * a build step, the variable will use the build step value. The elements are * of the form "KEY=VALUE" for the environment variable "KEY" being given the * value "VALUE". */ env?: string[]; /** * Option to specify the logging mode, which determines if and where build * logs are stored. */ logging?: | "LOGGING_UNSPECIFIED" | "LEGACY" | "GCS_ONLY" | "STACKDRIVER_ONLY" | "CLOUD_LOGGING_ONLY" | "NONE"; /** * Option to define build log streaming behavior to Cloud Storage. */ logStreamingOption?: | "STREAM_DEFAULT" | "STREAM_ON" | "STREAM_OFF"; /** * Compute Engine machine type on which to run the build. */ machineType?: | "UNSPECIFIED" | "N1_HIGHCPU_8" | "N1_HIGHCPU_32" | "E2_HIGHCPU_8" | "E2_HIGHCPU_32" | "E2_MEDIUM"; /** * Optional. Specification for execution on a `WorkerPool`. See [running * builds in a private * pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) * for more information. */ pool?: GoogleDevtoolsCloudbuildV1PoolOption; /** * Requested verifiability options. */ requestedVerifyOption?: | "NOT_VERIFIED" | "VERIFIED"; /** * A list of global environment variables, which are encrypted using a Cloud * Key Management Service crypto key. These values must be specified in the * build's `Secret`. These variables will be available to all build steps in * this build. */ secretEnv?: string[]; /** * Requested hash for SourceProvenance. */ sourceProvenanceHash?: | "NONE" | "SHA256" | "MD5" | "SHA512"[]; /** * Option to specify behavior when there is an error in the substitution * checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and * cannot be overridden in the build configuration file. */ substitutionOption?: | "MUST_MATCH" | "ALLOW_LOOSE"; /** * Global list of volumes to mount for ALL build steps Each volume is created * as an empty volume prior to starting the build process. Upon completion of * the build, volumes and their contents are discarded. Global volume names * and paths cannot conflict with the volumes defined a build step. Using a * global volume in a build with only one step is not valid as it is * indicative of a build request with an incorrect configuration. */ volumes?: GoogleDevtoolsCloudbuildV1Volume[]; /** * This field deprecated; please use `pool.name` instead. */ workerPool?: string; } function serializeGoogleDevtoolsCloudbuildV1BuildOptions(data: any): GoogleDevtoolsCloudbuildV1BuildOptions { return { ...data, diskSizeGb: data["diskSizeGb"] !== undefined ? String(data["diskSizeGb"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1BuildOptions(data: any): GoogleDevtoolsCloudbuildV1BuildOptions { return { ...data, diskSizeGb: data["diskSizeGb"] !== undefined ? BigInt(data["diskSizeGb"]) : undefined, }; } /** * A step in the build pipeline. */ export interface GoogleDevtoolsCloudbuildV1BuildStep { /** * Allow this build step to fail without failing the entire build if and only * if the exit code is one of the specified codes. If allow_failure is also * specified, this field will take precedence. */ allowExitCodes?: number[]; /** * Allow this build step to fail without failing the entire build. If false, * the entire build will fail if this step fails. Otherwise, the build will * succeed, but this step will still have a failure status. Error information * will be reported in the failure_detail field. */ allowFailure?: boolean; /** * A list of arguments that will be presented to the step when it is started. * If the image used to run the step's container has an entrypoint, the `args` * are used as arguments to that entrypoint. If the image does not define an * entrypoint, the first element in args is used as the entrypoint, and the * remainder will be used as arguments. */ args?: string[]; /** * Option to include built-in and custom substitutions as env variables for * this build step. This option will override the global option in * BuildOption. */ automapSubstitutions?: boolean; /** * Working directory to use when running this step's container. If this value * is a relative path, it is relative to the build's working directory. If * this value is absolute, it may be outside the build's working directory, in * which case the contents of the path may not be persisted across build step * executions, unless a `volume` for that path is specified. If the build * specifies a `RepoSource` with `dir` and a step with a `dir`, which * specifies an absolute path, the `RepoSource` `dir` is ignored for the * step's execution. */ dir?: string; /** * Entrypoint to be used instead of the build step image's default * entrypoint. If unset, the image's default entrypoint is used. */ entrypoint?: string; /** * A list of environment variable definitions to be used when running a step. * The elements are of the form "KEY=VALUE" for the environment variable "KEY" * being given the value "VALUE". */ env?: string[]; /** * Output only. Return code from running the step. */ readonly exitCode?: number; /** * Unique identifier for this build step, used in `wait_for` to reference * this build step as a dependency. */ id?: string; /** * Required. The name of the container image that will run this particular * build step. If the image is available in the host's Docker daemon's cache, * it will be run directly. If not, the host will attempt to pull the image * first, using the builder service account's credentials if necessary. The * Docker daemon's cache will already have the latest versions of all of the * officially supported build steps * ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). * The Docker daemon will also have cached many of the layers for some popular * images, like "ubuntu", "debian", but they will be refreshed at the time you * attempt to use them. If you built an image in a previous build step, it * will be stored in the host's Docker daemon's cache and is available to use * as the name for a later build step. */ name?: string; /** * Output only. Stores timing information for pulling this build step's * builder image only. */ readonly pullTiming?: GoogleDevtoolsCloudbuildV1TimeSpan; /** * A shell script to be executed in the step. When script is provided, the * user cannot specify the entrypoint or args. */ script?: string; /** * A list of environment variables which are encrypted using a Cloud Key * Management Service crypto key. These values must be specified in the * build's `Secret`. */ secretEnv?: string[]; /** * Output only. Status of the build step. At this time, build step status is * only updated on build completion; step status is not updated in real-time * as the build progresses. */ readonly status?: | "STATUS_UNKNOWN" | "PENDING" | "QUEUED" | "WORKING" | "SUCCESS" | "FAILURE" | "INTERNAL_ERROR" | "TIMEOUT" | "CANCELLED" | "EXPIRED"; /** * Time limit for executing this build step. If not defined, the step has no * time limit and will be allowed to continue to run until either it completes * or the build itself times out. */ timeout?: number /* Duration */; /** * Output only. Stores timing information for executing this build step. */ readonly timing?: GoogleDevtoolsCloudbuildV1TimeSpan; /** * List of volumes to mount into the build step. Each volume is created as an * empty volume prior to execution of the build step. Upon completion of the * build, volumes and their contents are discarded. Using a named volume in * only one step is not valid as it is indicative of a build request with an * incorrect configuration. */ volumes?: GoogleDevtoolsCloudbuildV1Volume[]; /** * The ID(s) of the step(s) that this build step depends on. This build step * will not start until all the build steps in `wait_for` have completed * successfully. If `wait_for` is empty, this build step will start when all * previous build steps in the `Build.Steps` list have completed successfully. */ waitFor?: string[]; } function serializeGoogleDevtoolsCloudbuildV1BuildStep(data: any): GoogleDevtoolsCloudbuildV1BuildStep { return { ...data, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1BuildStep(data: any): GoogleDevtoolsCloudbuildV1BuildStep { return { ...data, pullTiming: data["pullTiming"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1TimeSpan(data["pullTiming"]) : undefined, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, timing: data["timing"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1TimeSpan(data["timing"]) : undefined, }; } /** * An image built by the pipeline. */ export interface GoogleDevtoolsCloudbuildV1BuiltImage { /** * Docker Registry 2.0 digest. */ digest?: string; /** * Name used to push the container image to Google Container Registry, as * presented to `docker push`. */ name?: string; /** * Output only. Stores timing information for pushing the specified image. */ readonly pushTiming?: GoogleDevtoolsCloudbuildV1TimeSpan; } /** * Location of the source in a 2nd-gen Google Cloud Build repository resource. */ export interface GoogleDevtoolsCloudbuildV1ConnectedRepository { /** * Optional. Directory, relative to the source root, in which to run the * build. */ dir?: string; /** * Required. Name of the Google Cloud Build repository, formatted as * `projects/*\/locations/*\/connections/*\/repositories/*`. */ repository?: string; /** * Required. The revision to fetch from the Git repository such as a branch, * a tag, a commit SHA, or any Git ref. */ revision?: string; } /** * This config defines the location of a source through Developer Connect. */ export interface GoogleDevtoolsCloudbuildV1DeveloperConnectConfig { /** * Required. Directory, relative to the source root, in which to run the * build. */ dir?: string; /** * Required. The Developer Connect Git repository link, formatted as * `projects/*\/locations/*\/connections/*\/gitRepositoryLink/*`. */ gitRepositoryLink?: string; /** * Required. The revision to fetch from the Git repository such as a branch, * a tag, a commit SHA, or any Git ref. */ revision?: string; } /** * A fatal problem encountered during the execution of the build. */ export interface GoogleDevtoolsCloudbuildV1FailureInfo { /** * Explains the failure issue in more detail using hard-coded text. */ detail?: string; /** * The name of the failure. */ type?: | "FAILURE_TYPE_UNSPECIFIED" | "PUSH_FAILED" | "PUSH_IMAGE_NOT_FOUND" | "PUSH_NOT_AUTHORIZED" | "LOGGING_FAILURE" | "USER_BUILD_STEP" | "FETCH_SOURCE_FAILED"; } /** * Container message for hashes of byte content of files, used in * SourceProvenance messages to verify integrity of source input to the build. */ export interface GoogleDevtoolsCloudbuildV1FileHashes { /** * Collection of file hashes. */ fileHash?: GoogleDevtoolsCloudbuildV1Hash[]; } function serializeGoogleDevtoolsCloudbuildV1FileHashes(data: any): GoogleDevtoolsCloudbuildV1FileHashes { return { ...data, fileHash: data["fileHash"] !== undefined ? data["fileHash"].map((item: any) => (serializeGoogleDevtoolsCloudbuildV1Hash(item))) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1FileHashes(data: any): GoogleDevtoolsCloudbuildV1FileHashes { return { ...data, fileHash: data["fileHash"] !== undefined ? data["fileHash"].map((item: any) => (deserializeGoogleDevtoolsCloudbuildV1Hash(item))) : undefined, }; } /** * GitConfig is a configuration for git operations. */ export interface GoogleDevtoolsCloudbuildV1GitConfig { /** * Configuration for HTTP related git operations. */ http?: GoogleDevtoolsCloudbuildV1HttpConfig; } /** * Location of the source in any accessible Git repository. */ export interface GoogleDevtoolsCloudbuildV1GitSource { /** * Optional. Directory, relative to the source root, in which to run the * build. This must be a relative path. If a step's `dir` is specified and is * an absolute path, this value is ignored for that step's execution. */ dir?: string; /** * Optional. The revision to fetch from the Git repository such as a branch, * a tag, a commit SHA, or any Git ref. Cloud Build uses `git fetch` to fetch * the revision from the Git repository; therefore make sure that the string * you provide for `revision` is parsable by the command. For information on * string values accepted by `git fetch`, see * https://git-scm.com/docs/gitrevisions#_specifying_revisions. For * information on `git fetch`, see https://git-scm.com/docs/git-fetch. */ revision?: string; /** * Required. Location of the Git repo to build. This will be used as a `git * remote`, see https://git-scm.com/docs/git-remote. */ url?: string; } /** * Container message for hash values. */ export interface GoogleDevtoolsCloudbuildV1Hash { /** * The type of hash that was performed. */ type?: | "NONE" | "SHA256" | "MD5" | "SHA512"; /** * The hash value. */ value?: Uint8Array; } function serializeGoogleDevtoolsCloudbuildV1Hash(data: any): GoogleDevtoolsCloudbuildV1Hash { return { ...data, value: data["value"] !== undefined ? encodeBase64(data["value"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1Hash(data: any): GoogleDevtoolsCloudbuildV1Hash { return { ...data, value: data["value"] !== undefined ? decodeBase64(data["value"] as string) : undefined, }; } /** * HttpConfig is a configuration for HTTP related git operations. */ export interface GoogleDevtoolsCloudbuildV1HttpConfig { /** * SecretVersion resource of the HTTP proxy URL. The Service Account used in * the build (either the default Service Account or user-specified Service * Account) should have `secretmanager.versions.access` permissions on this * secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. */ proxySecretVersionName?: string; } /** * Pairs a set of secret environment variables mapped to encrypted values with * the Cloud KMS key to use to decrypt the value. */ export interface GoogleDevtoolsCloudbuildV1InlineSecret { /** * Map of environment variable name to its encrypted value. Secret * environment variables must be unique across all of a build's secrets, and * must be used by at least one build step. Values can be at most 64 KB in * size. There can be at most 100 secret values across all of a build's * secrets. */ envMap?: { [key: string]: Uint8Array }; /** * Resource name of Cloud KMS crypto key to decrypt the encrypted value. In * format: projects/*\/locations/*\/keyRings/*\/cryptoKeys/* */ kmsKeyName?: string; } function serializeGoogleDevtoolsCloudbuildV1InlineSecret(data: any): GoogleDevtoolsCloudbuildV1InlineSecret { return { ...data, envMap: data["envMap"] !== undefined ? Object.fromEntries(Object.entries(data["envMap"]).map(([k, v]: [string, any]) => ([k, encodeBase64(v)]))) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1InlineSecret(data: any): GoogleDevtoolsCloudbuildV1InlineSecret { return { ...data, envMap: data["envMap"] !== undefined ? Object.fromEntries(Object.entries(data["envMap"]).map(([k, v]: [string, any]) => ([k, decodeBase64(v as string)]))) : undefined, }; } /** * A Maven artifact to upload to Artifact Registry upon successful completion * of all build steps. */ export interface GoogleDevtoolsCloudbuildV1MavenArtifact { /** * Maven `artifactId` value used when uploading the artifact to Artifact * Registry. */ artifactId?: string; /** * Maven `groupId` value used when uploading the artifact to Artifact * Registry. */ groupId?: string; /** * Path to an artifact in the build's workspace to be uploaded to Artifact * Registry. This can be either an absolute path, e.g. * /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from * /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar. */ path?: string; /** * Artifact Registry repository, in the form * "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the * workspace specified by path will be uploaded to Artifact Registry with this * location as a prefix. */ repository?: string; /** * Maven `version` value used when uploading the artifact to Artifact * Registry. */ version?: string; } /** * Npm package to upload to Artifact Registry upon successful completion of all * build steps. */ export interface GoogleDevtoolsCloudbuildV1NpmPackage { /** * Path to the package.json. e.g. workspace/path/to/package */ packagePath?: string; /** * Artifact Registry repository, in the form * "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the * workspace specified by path will be zipped and uploaded to Artifact * Registry with this location as a prefix. */ repository?: string; } /** * Details about how a build should be executed on a `WorkerPool`. See [running * builds in a private * pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) * for more information. */ export interface GoogleDevtoolsCloudbuildV1PoolOption { /** * The `WorkerPool` resource to execute the build on. You must have * `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format * projects/{project}/locations/{location}/workerPools/{workerPoolId} */ name?: string; } /** * Python package to upload to Artifact Registry upon successful completion of * all build steps. A package can encapsulate multiple objects to be uploaded to * a single repository. */ export interface GoogleDevtoolsCloudbuildV1PythonPackage { /** * Path globs used to match files in the build's workspace. For Python/ * Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. */ paths?: string[]; /** * Artifact Registry repository, in the form * "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the * workspace matching any path pattern will be uploaded to Artifact Registry * with this location as a prefix. */ repository?: string; } /** * Location of the source in a Google Cloud Source Repository. */ export interface GoogleDevtoolsCloudbuildV1RepoSource { /** * Regex matching branches to build. The syntax of the regular expressions * accepted is the syntax accepted by RE2 and described at * https://github.com/google/re2/wiki/Syntax */ branchName?: string; /** * Explicit commit SHA to build. */ commitSha?: string; /** * Optional. Directory, relative to the source root, in which to run the * build. This must be a relative path. If a step's `dir` is specified and is * an absolute path, this value is ignored for that step's execution. */ dir?: string; /** * Optional. Only trigger a build if the revision regex does NOT match the * revision regex. */ invertRegex?: boolean; /** * Optional. ID of the project that owns the Cloud Source Repository. If * omitted, the project ID requesting the build is assumed. */ projectId?: string; /** * Required. Name of the Cloud Source Repository. */ repoName?: string; /** * Optional. Substitutions to use in a triggered build. Should only be used * with RunBuildTrigger */ substitutions?: { [key: string]: string }; /** * Regex matching tags to build. The syntax of the regular expressions * accepted is the syntax accepted by RE2 and described at * https://github.com/google/re2/wiki/Syntax */ tagName?: string; } /** * Artifacts created by the build pipeline. */ export interface GoogleDevtoolsCloudbuildV1Results { /** * Path to the artifact manifest for non-container artifacts uploaded to * Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage. */ artifactManifest?: string; /** * Time to push all non-container artifacts to Cloud Storage. */ artifactTiming?: GoogleDevtoolsCloudbuildV1TimeSpan; /** * List of build step digests, in the order corresponding to build step * indices. */ buildStepImages?: string[]; /** * List of build step outputs, produced by builder images, in the order * corresponding to build step indices. [Cloud * Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can * produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first * 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is * read-only and can't be substituted. */ buildStepOutputs?: Uint8Array[]; /** * Container images that were built as a part of the build. */ images?: GoogleDevtoolsCloudbuildV1BuiltImage[]; /** * Maven artifacts uploaded to Artifact Registry at the end of the build. */ mavenArtifacts?: GoogleDevtoolsCloudbuildV1UploadedMavenArtifact[]; /** * Npm packages uploaded to Artifact Registry at the end of the build. */ npmPackages?: GoogleDevtoolsCloudbuildV1UploadedNpmPackage[]; /** * Number of non-container artifacts uploaded to Cloud Storage. Only * populated when artifacts are uploaded to Cloud Storage. */ numArtifacts?: bigint; /** * Python artifacts uploaded to Artifact Registry at the end of the build. */ pythonPackages?: GoogleDevtoolsCloudbuildV1UploadedPythonPackage[]; } function serializeGoogleDevtoolsCloudbuildV1Results(data: any): GoogleDevtoolsCloudbuildV1Results { return { ...data, artifactTiming: data["artifactTiming"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1TimeSpan(data["artifactTiming"]) : undefined, buildStepOutputs: data["buildStepOutputs"] !== undefined ? data["buildStepOutputs"].map((item: any) => (encodeBase64(item))) : undefined, mavenArtifacts: data["mavenArtifacts"] !== undefined ? data["mavenArtifacts"].map((item: any) => (serializeGoogleDevtoolsCloudbuildV1UploadedMavenArtifact(item))) : undefined, npmPackages: data["npmPackages"] !== undefined ? data["npmPackages"].map((item: any) => (serializeGoogleDevtoolsCloudbuildV1UploadedNpmPackage(item))) : undefined, numArtifacts: data["numArtifacts"] !== undefined ? String(data["numArtifacts"]) : undefined, pythonPackages: data["pythonPackages"] !== undefined ? data["pythonPackages"].map((item: any) => (serializeGoogleDevtoolsCloudbuildV1UploadedPythonPackage(item))) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1Results(data: any): GoogleDevtoolsCloudbuildV1Results { return { ...data, artifactTiming: data["artifactTiming"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1TimeSpan(data["artifactTiming"]) : undefined, buildStepOutputs: data["buildStepOutputs"] !== undefined ? data["buildStepOutputs"].map((item: any) => (decodeBase64(item as string))) : undefined, mavenArtifacts: data["mavenArtifacts"] !== undefined ? data["mavenArtifacts"].map((item: any) => (deserializeGoogleDevtoolsCloudbuildV1UploadedMavenArtifact(item))) : undefined, npmPackages: data["npmPackages"] !== undefined ? data["npmPackages"].map((item: any) => (deserializeGoogleDevtoolsCloudbuildV1UploadedNpmPackage(item))) : undefined, numArtifacts: data["numArtifacts"] !== undefined ? BigInt(data["numArtifacts"]) : undefined, pythonPackages: data["pythonPackages"] !== undefined ? data["pythonPackages"].map((item: any) => (deserializeGoogleDevtoolsCloudbuildV1UploadedPythonPackage(item))) : undefined, }; } /** * Pairs a set of secret environment variables containing encrypted values with * the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with * `available_secrets` instead of using `kmsKeyName` with `secret`. For * instructions see: * https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials. */ export interface GoogleDevtoolsCloudbuildV1Secret { /** * Cloud KMS key name to use to decrypt these envs. */ kmsKeyName?: string; /** * Map of environment variable name to its encrypted value. Secret * environment variables must be unique across all of a build's secrets, and * must be used by at least one build step. Values can be at most 64 KB in * size. There can be at most 100 secret values across all of a build's * secrets. */ secretEnv?: { [key: string]: Uint8Array }; } function serializeGoogleDevtoolsCloudbuildV1Secret(data: any): GoogleDevtoolsCloudbuildV1Secret { return { ...data, secretEnv: data["secretEnv"] !== undefined ? Object.fromEntries(Object.entries(data["secretEnv"]).map(([k, v]: [string, any]) => ([k, encodeBase64(v)]))) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1Secret(data: any): GoogleDevtoolsCloudbuildV1Secret { return { ...data, secretEnv: data["secretEnv"] !== undefined ? Object.fromEntries(Object.entries(data["secretEnv"]).map(([k, v]: [string, any]) => ([k, decodeBase64(v as string)]))) : undefined, }; } /** * Pairs a secret environment variable with a SecretVersion in Secret Manager. */ export interface GoogleDevtoolsCloudbuildV1SecretManagerSecret { /** * Environment variable name to associate with the secret. Secret environment * variables must be unique across all of a build's secrets, and must be used * by at least one build step. */ env?: string; /** * Resource name of the SecretVersion. In format: * projects/*\/secrets/*\/versions/* */ versionName?: string; } /** * Secrets and secret environment variables. */ export interface GoogleDevtoolsCloudbuildV1Secrets { /** * Secrets encrypted with KMS key and the associated secret environment * variable. */ inline?: GoogleDevtoolsCloudbuildV1InlineSecret[]; /** * Secrets in Secret Manager and associated secret environment variable. */ secretManager?: GoogleDevtoolsCloudbuildV1SecretManagerSecret[]; } function serializeGoogleDevtoolsCloudbuildV1Secrets(data: any): GoogleDevtoolsCloudbuildV1Secrets { return { ...data, inline: data["inline"] !== undefined ? data["inline"].map((item: any) => (serializeGoogleDevtoolsCloudbuildV1InlineSecret(item))) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1Secrets(data: any): GoogleDevtoolsCloudbuildV1Secrets { return { ...data, inline: data["inline"] !== undefined ? data["inline"].map((item: any) => (deserializeGoogleDevtoolsCloudbuildV1InlineSecret(item))) : undefined, }; } /** * Location of the source in a supported storage service. */ export interface GoogleDevtoolsCloudbuildV1Source { /** * Optional. If provided, get the source from this 2nd-gen Google Cloud Build * repository resource. */ connectedRepository?: GoogleDevtoolsCloudbuildV1ConnectedRepository; /** * If provided, get the source from this Developer Connect config. */ developerConnectConfig?: GoogleDevtoolsCloudbuildV1DeveloperConnectConfig; /** * If provided, get the source from this Git repository. */ gitSource?: GoogleDevtoolsCloudbuildV1GitSource; /** * If provided, get the source from this location in a Cloud Source * Repository. */ repoSource?: GoogleDevtoolsCloudbuildV1RepoSource; /** * If provided, get the source from this location in Cloud Storage. */ storageSource?: GoogleDevtoolsCloudbuildV1StorageSource; /** * If provided, get the source from this manifest in Cloud Storage. This * feature is in Preview; see description * [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). */ storageSourceManifest?: GoogleDevtoolsCloudbuildV1StorageSourceManifest; } function serializeGoogleDevtoolsCloudbuildV1Source(data: any): GoogleDevtoolsCloudbuildV1Source { return { ...data, storageSource: data["storageSource"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1StorageSource(data["storageSource"]) : undefined, storageSourceManifest: data["storageSourceManifest"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1StorageSourceManifest(data["storageSourceManifest"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1Source(data: any): GoogleDevtoolsCloudbuildV1Source { return { ...data, storageSource: data["storageSource"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1StorageSource(data["storageSource"]) : undefined, storageSourceManifest: data["storageSourceManifest"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1StorageSourceManifest(data["storageSourceManifest"]) : undefined, }; } /** * Provenance of the source. Ways to find the original source, or verify that * some source was used for this build. */ export interface GoogleDevtoolsCloudbuildV1SourceProvenance { /** * Output only. Hash(es) of the build source, which can be used to verify * that the original source integrity was maintained in the build. Note that * `FileHashes` will only be populated if `BuildOptions` has requested a * `SourceProvenanceHash`. The keys to this map are file paths used as build * source and the values contain the hash values for those files. If the build * source came in a single package such as a gzipped tarfile (`.tar.gz`), the * `FileHash` will be for the single path to that file. */ readonly fileHashes?: { [key: string]: GoogleDevtoolsCloudbuildV1FileHashes }; /** * Output only. A copy of the build's `source.connected_repository`, if * exists, with any revisions resolved. */ readonly resolvedConnectedRepository?: GoogleDevtoolsCloudbuildV1ConnectedRepository; /** * Output only. A copy of the build's `source.git_source`, if exists, with * any revisions resolved. */ readonly resolvedGitSource?: GoogleDevtoolsCloudbuildV1GitSource; /** * A copy of the build's `source.repo_source`, if exists, with any revisions * resolved. */ resolvedRepoSource?: GoogleDevtoolsCloudbuildV1RepoSource; /** * A copy of the build's `source.storage_source`, if exists, with any * generations resolved. */ resolvedStorageSource?: GoogleDevtoolsCloudbuildV1StorageSource; /** * A copy of the build's `source.storage_source_manifest`, if exists, with * any revisions resolved. This feature is in Preview. */ resolvedStorageSourceManifest?: GoogleDevtoolsCloudbuildV1StorageSourceManifest; } function serializeGoogleDevtoolsCloudbuildV1SourceProvenance(data: any): GoogleDevtoolsCloudbuildV1SourceProvenance { return { ...data, resolvedStorageSource: data["resolvedStorageSource"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1StorageSource(data["resolvedStorageSource"]) : undefined, resolvedStorageSourceManifest: data["resolvedStorageSourceManifest"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1StorageSourceManifest(data["resolvedStorageSourceManifest"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1SourceProvenance(data: any): GoogleDevtoolsCloudbuildV1SourceProvenance { return { ...data, fileHashes: data["fileHashes"] !== undefined ? Object.fromEntries(Object.entries(data["fileHashes"]).map(([k, v]: [string, any]) => ([k, deserializeGoogleDevtoolsCloudbuildV1FileHashes(v)]))) : undefined, resolvedStorageSource: data["resolvedStorageSource"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1StorageSource(data["resolvedStorageSource"]) : undefined, resolvedStorageSourceManifest: data["resolvedStorageSourceManifest"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1StorageSourceManifest(data["resolvedStorageSourceManifest"]) : undefined, }; } /** * Location of the source in an archive file in Cloud Storage. */ export interface GoogleDevtoolsCloudbuildV1StorageSource { /** * Cloud Storage bucket containing the source (see [Bucket Name * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). */ bucket?: string; /** * Optional. Cloud Storage generation for the object. If the generation is * omitted, the latest generation will be used. */ generation?: bigint; /** * Required. Cloud Storage object containing the source. This object must be * a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to * build. */ object?: string; /** * Optional. Option to specify the tool to fetch the source file for the * build. */ sourceFetcher?: | "SOURCE_FETCHER_UNSPECIFIED" | "GSUTIL" | "GCS_FETCHER"; } function serializeGoogleDevtoolsCloudbuildV1StorageSource(data: any): GoogleDevtoolsCloudbuildV1StorageSource { return { ...data, generation: data["generation"] !== undefined ? String(data["generation"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1StorageSource(data: any): GoogleDevtoolsCloudbuildV1StorageSource { return { ...data, generation: data["generation"] !== undefined ? BigInt(data["generation"]) : undefined, }; } /** * Location of the source manifest in Cloud Storage. This feature is in * Preview; see description * [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). */ export interface GoogleDevtoolsCloudbuildV1StorageSourceManifest { /** * Required. Cloud Storage bucket containing the source manifest (see [Bucket * Name * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). */ bucket?: string; /** * Cloud Storage generation for the object. If the generation is omitted, the * latest generation will be used. */ generation?: bigint; /** * Required. Cloud Storage object containing the source manifest. This object * must be a JSON file. */ object?: string; } function serializeGoogleDevtoolsCloudbuildV1StorageSourceManifest(data: any): GoogleDevtoolsCloudbuildV1StorageSourceManifest { return { ...data, generation: data["generation"] !== undefined ? String(data["generation"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1StorageSourceManifest(data: any): GoogleDevtoolsCloudbuildV1StorageSourceManifest { return { ...data, generation: data["generation"] !== undefined ? BigInt(data["generation"]) : undefined, }; } /** * Start and end times for a build execution phase. */ export interface GoogleDevtoolsCloudbuildV1TimeSpan { /** * End of time span. */ endTime?: Date; /** * Start of time span. */ startTime?: Date; } function serializeGoogleDevtoolsCloudbuildV1TimeSpan(data: any): GoogleDevtoolsCloudbuildV1TimeSpan { return { ...data, endTime: data["endTime"] !== undefined ? data["endTime"].toISOString() : undefined, startTime: data["startTime"] !== undefined ? data["startTime"].toISOString() : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1TimeSpan(data: any): GoogleDevtoolsCloudbuildV1TimeSpan { return { ...data, endTime: data["endTime"] !== undefined ? new Date(data["endTime"]) : undefined, startTime: data["startTime"] !== undefined ? new Date(data["startTime"]) : undefined, }; } /** * A Maven artifact uploaded using the MavenArtifact directive. */ export interface GoogleDevtoolsCloudbuildV1UploadedMavenArtifact { /** * Hash types and values of the Maven Artifact. */ fileHashes?: GoogleDevtoolsCloudbuildV1FileHashes; /** * Output only. Stores timing information for pushing the specified artifact. */ readonly pushTiming?: GoogleDevtoolsCloudbuildV1TimeSpan; /** * URI of the uploaded artifact. */ uri?: string; } function serializeGoogleDevtoolsCloudbuildV1UploadedMavenArtifact(data: any): GoogleDevtoolsCloudbuildV1UploadedMavenArtifact { return { ...data, fileHashes: data["fileHashes"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1FileHashes(data["fileHashes"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1UploadedMavenArtifact(data: any): GoogleDevtoolsCloudbuildV1UploadedMavenArtifact { return { ...data, fileHashes: data["fileHashes"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1FileHashes(data["fileHashes"]) : undefined, pushTiming: data["pushTiming"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1TimeSpan(data["pushTiming"]) : undefined, }; } /** * An npm package uploaded to Artifact Registry using the NpmPackage directive. */ export interface GoogleDevtoolsCloudbuildV1UploadedNpmPackage { /** * Hash types and values of the npm package. */ fileHashes?: GoogleDevtoolsCloudbuildV1FileHashes; /** * Output only. Stores timing information for pushing the specified artifact. */ readonly pushTiming?: GoogleDevtoolsCloudbuildV1TimeSpan; /** * URI of the uploaded npm package. */ uri?: string; } function serializeGoogleDevtoolsCloudbuildV1UploadedNpmPackage(data: any): GoogleDevtoolsCloudbuildV1UploadedNpmPackage { return { ...data, fileHashes: data["fileHashes"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1FileHashes(data["fileHashes"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1UploadedNpmPackage(data: any): GoogleDevtoolsCloudbuildV1UploadedNpmPackage { return { ...data, fileHashes: data["fileHashes"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1FileHashes(data["fileHashes"]) : undefined, pushTiming: data["pushTiming"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1TimeSpan(data["pushTiming"]) : undefined, }; } /** * Artifact uploaded using the PythonPackage directive. */ export interface GoogleDevtoolsCloudbuildV1UploadedPythonPackage { /** * Hash types and values of the Python Artifact. */ fileHashes?: GoogleDevtoolsCloudbuildV1FileHashes; /** * Output only. Stores timing information for pushing the specified artifact. */ readonly pushTiming?: GoogleDevtoolsCloudbuildV1TimeSpan; /** * URI of the uploaded artifact. */ uri?: string; } function serializeGoogleDevtoolsCloudbuildV1UploadedPythonPackage(data: any): GoogleDevtoolsCloudbuildV1UploadedPythonPackage { return { ...data, fileHashes: data["fileHashes"] !== undefined ? serializeGoogleDevtoolsCloudbuildV1FileHashes(data["fileHashes"]) : undefined, }; } function deserializeGoogleDevtoolsCloudbuildV1UploadedPythonPackage(data: any): GoogleDevtoolsCloudbuildV1UploadedPythonPackage { return { ...data, fileHashes: data["fileHashes"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1FileHashes(data["fileHashes"]) : undefined, pushTiming: data["pushTiming"] !== undefined ? deserializeGoogleDevtoolsCloudbuildV1TimeSpan(data["pushTiming"]) : undefined, }; } /** * Volume describes a Docker container volume which is mounted into build steps * in order to persist files across build step execution. */ export interface GoogleDevtoolsCloudbuildV1Volume { /** * Name of the volume to mount. Volume names must be unique per build step * and must be valid names for Docker volumes. Each named volume must be used * by at least two build steps. */ name?: string; /** * Path at which to mount the volume. Paths must be absolute and cannot * conflict with other volume paths on the same build step or with certain * reserved volume paths. */ path?: string; } /** * A non-fatal problem encountered during the execution of the build. */ export interface GoogleDevtoolsCloudbuildV1Warning { /** * The priority for this warning. */ priority?: | "PRIORITY_UNSPECIFIED" | "INFO" | "WARNING" | "ALERT"; /** * Explanation of the warning generated. */ text?: string; } /** * Specifies the audit configuration for a service. The configuration * determines which permission types are logged, and what identities, if any, * are exempted from logging. An AuditConfig must have one or more * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a * specific service, the union of the two AuditConfigs is used for that service: * the log_types specified in each AuditConfig are enabled, and the * exempted_members in each AuditLogConfig are exempted. Example Policy with * multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", * "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ * "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": * "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", * "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": * "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For * sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ * logging. It also exempts `jose@example.com` from DATA_READ logging, and * `aliya@example.com` from DATA_WRITE logging. */ export interface GoogleIamV1AuditConfig { /** * The configuration for logging of each type of permission. */ auditLogConfigs?: GoogleIamV1AuditLogConfig[]; /** * Specifies a service that will be enabled for audit logging. For example, * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a * special value that covers all services. */ service?: string; } /** * Provides the configuration for logging a type of permissions. Example: { * "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ * "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables * 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from * DATA_READ logging. */ export interface GoogleIamV1AuditLogConfig { /** * Specifies the identities that do not cause logging for this type of * permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** * The log type that this config enables. */ logType?: | "LOG_TYPE_UNSPECIFIED" | "ADMIN_READ" | "DATA_WRITE" | "DATA_READ"; } /** * Associates `members`, or principals, with a `role`. */ export interface GoogleIamV1Binding { /** * 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?: GoogleTypeExpr; /** * Specifies the principals requesting access for a Google Cloud resource. * `members` can have the following values: * `allUsers`: A special identifier * that represents anyone who is on the internet; with or without a Google * account. * `allAuthenticatedUsers`: A special identifier that represents * anyone who is authenticated with a Google account or a service account. * Does not include identities that come from external identity providers * (IdPs) through identity federation. * `user:{emailid}`: An email address * that represents a specific Google account. For example, `alice@example.com` * . * `serviceAccount:{emailid}`: An email address that represents a Google * service account. For example, `my-other-app@appspot.gserviceaccount.com`. * * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An * identifier for a [Kubernetes service * account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). * For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * * `group:{emailid}`: An email address that represents a Google group. For * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain * (primary) that represents all the users of that domain. For example, * `google.com` or `example.com`. * * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: * A single identity in a workforce identity pool. * * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: * All workforce identities in a group. * * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: * All workforce identities with a specific attribute value. * * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: * All identities in a workforce identity pool. * * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: * A single identity in a workload identity pool. * * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: * A workload identity pool group. * * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: * All identities in a workload identity pool with a certain attribute. * * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: * All identities in a workload identity pool. * * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique * identifier) representing a user that has been recently deleted. For * example, `alice@example.com?uid=123456789012345678901`. If the user is * recovered, this value reverts to `user:{emailid}` and the recovered user * retains the role in the binding. * * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus * unique identifier) representing a service account that has been recently * deleted. For example, * `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If * the service account is undeleted, this value reverts to * `serviceAccount:{emailid}` and the undeleted service account retains the * role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email * address (plus unique identifier) representing a Google group that has been * recently deleted. For example, * `admins@example.com?uid=123456789012345678901`. If the group is recovered, * this value reverts to `group:{emailid}` and the recovered group retains the * role in the binding. * * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: * Deleted single identity in a workforce identity pool. For example, * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. */ members?: string[]; /** * Role that is assigned to the list of `members`, or principals. For * example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview * of the IAM roles and permissions, see the [IAM * documentation](https://cloud.google.com/iam/docs/roles-overview). For a * list of the available pre-defined roles, see * [here](https://cloud.google.com/iam/docs/understanding-roles). */ role?: string; } /** * 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 GoogleIamV1Policy { /** * Specifies cloud audit logging configuration for this policy. */ auditConfigs?: GoogleIamV1AuditConfig[]; /** * 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?: GoogleIamV1Binding[]; /** * `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?: Uint8Array; /** * 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; } function serializeGoogleIamV1Policy(data: any): GoogleIamV1Policy { return { ...data, etag: data["etag"] !== undefined ? encodeBase64(data["etag"]) : undefined, }; } function deserializeGoogleIamV1Policy(data: any): GoogleIamV1Policy { return { ...data, etag: data["etag"] !== undefined ? decodeBase64(data["etag"] as string) : undefined, }; } /** * Request message for `SetIamPolicy` method. */ export interface GoogleIamV1SetIamPolicyRequest { /** * 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?: GoogleIamV1Policy; /** * OPTIONAL: A FieldMask specifying which fields of the policy to modify. * Only the fields in the mask will be modified. If no mask is provided, the * following default mask is used: `paths: "bindings, etag"` */ updateMask?: string /* FieldMask */; } function serializeGoogleIamV1SetIamPolicyRequest(data: any): GoogleIamV1SetIamPolicyRequest { return { ...data, policy: data["policy"] !== undefined ? serializeGoogleIamV1Policy(data["policy"]) : undefined, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeGoogleIamV1SetIamPolicyRequest(data: any): GoogleIamV1SetIamPolicyRequest { return { ...data, policy: data["policy"] !== undefined ? deserializeGoogleIamV1Policy(data["policy"]) : undefined, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Request message for `TestIamPermissions` method. */ export interface GoogleIamV1TestIamPermissionsRequest { /** * 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[]; } /** * Response message for `TestIamPermissions` method. */ export interface GoogleIamV1TestIamPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is * allowed. */ permissions?: string[]; } /** * The response message for Operations.ListOperations. */ export interface GoogleLongrunningListOperationsResponse { /** * The standard List next-page token. */ nextPageToken?: string; /** * A list of operations that matches the specified filter in the request. */ operations?: GoogleLongrunningOperation[]; } /** * This resource represents a long-running operation that is the result of a * network API call. */ export interface GoogleLongrunningOperation { /** * If the value is `false`, it means the operation is still in progress. If * `true`, the operation is completed, and either `error` or `response` is * available. */ done?: boolean; /** * The error result of the operation in case of failure or cancellation. */ error?: GoogleRpcStatus; /** * Service-specific metadata associated with the operation. It typically * contains progress information and common metadata such as create time. Some * services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ metadata?: { [key: string]: any }; /** * 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; /** * 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 }; } /** * The request message for Operations.WaitOperation. */ export interface GoogleLongrunningWaitOperationRequest { /** * The maximum duration to wait before timing out. If left blank, the wait * will be at most the time permitted by the underlying HTTP/RPC protocol. If * RPC context deadline is also specified, the shorter one will be used. */ timeout?: number /* Duration */; } function serializeGoogleLongrunningWaitOperationRequest(data: any): GoogleLongrunningWaitOperationRequest { return { ...data, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } function deserializeGoogleLongrunningWaitOperationRequest(data: any): GoogleLongrunningWaitOperationRequest { return { ...data, timeout: data["timeout"] !== undefined ? data["timeout"] : undefined, }; } /** * 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 GoogleProtobufEmpty { } /** * 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 GoogleRpcStatus { /** * The status code, which should be an enum value of google.rpc.Code. */ code?: number; /** * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ details?: { [key: string]: any }[]; /** * 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; } /** * 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 GoogleTypeExpr { /** * 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; /** * Textual representation of an expression in Common Expression Language * syntax. */ expression?: string; /** * Optional. String indicating the location of the expression for error * reporting, e.g. a file name and a position in the file. */ location?: string; /** * 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; } /** * Additional options for Run#projectsLocationsJobsCreate. */ export interface ProjectsLocationsJobsCreateOptions { /** * Required. The unique identifier for the Job. The name of the job becomes * {parent}/jobs/{job_id}. */ jobId?: string; /** * Indicates that the request should be validated and default values * populated, without persisting the request or creating any resources. */ validateOnly?: boolean; } /** * Additional options for Run#projectsLocationsJobsDelete. */ export interface ProjectsLocationsJobsDeleteOptions { /** * A system-generated fingerprint for this version of the resource. May be * used to detect modification conflict during updates. */ etag?: string; /** * Indicates that the request should be validated without actually deleting * any resources. */ validateOnly?: boolean; } /** * Additional options for Run#projectsLocationsJobsExecutionsDelete. */ export interface ProjectsLocationsJobsExecutionsDeleteOptions { /** * A system-generated fingerprint for this version of the resource. This may * be used to detect modification conflict during updates. */ etag?: string; /** * Indicates that the request should be validated without actually deleting * any resources. */ validateOnly?: boolean; } /** * Additional options for Run#projectsLocationsJobsExecutionsList. */ export interface ProjectsLocationsJobsExecutionsListOptions { /** * Maximum number of Executions to return in this call. */ pageSize?: number; /** * A page token received from a previous call to ListExecutions. All other * parameters must match. */ pageToken?: string; /** * If true, returns deleted (but unexpired) resources along with active ones. */ showDeleted?: boolean; } /** * Additional options for Run#projectsLocationsJobsExecutionsTasksList. */ export interface ProjectsLocationsJobsExecutionsTasksListOptions { /** * Maximum number of Tasks to return in this call. */ pageSize?: number; /** * A page token received from a previous call to ListTasks. All other * parameters must match. */ pageToken?: string; /** * If true, returns deleted (but unexpired) resources along with active ones. */ showDeleted?: boolean; } /** * Additional options for Run#projectsLocationsJobsGetIamPolicy. */ export interface ProjectsLocationsJobsGetIamPolicyOptions { /** * 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; } /** * Additional options for Run#projectsLocationsJobsList. */ export interface ProjectsLocationsJobsListOptions { /** * Maximum number of Jobs to return in this call. */ pageSize?: number; /** * A page token received from a previous call to ListJobs. All other * parameters must match. */ pageToken?: string; /** * If true, returns deleted (but unexpired) resources along with active ones. */ showDeleted?: boolean; } /** * Additional options for Run#projectsLocationsJobsPatch. */ export interface ProjectsLocationsJobsPatchOptions { /** * Optional. If set to true, and if the Job does not exist, it will create a * new one. Caller must have both create and update permissions for this call * if this is set to true. */ allowMissing?: boolean; /** * Indicates that the request should be validated and default values * populated, without persisting the request or updating any resources. */ validateOnly?: boolean; } /** * Additional options for Run#projectsLocationsOperationsList. */ export interface ProjectsLocationsOperationsListOptions { /** * Optional. A filter for matching the completed or in-progress operations. * The supported formats of *filter* are: To query for only completed * operations: done:true To query for only ongoing operations: done:false Must * be empty to query for all of the latest operations for the given parent * project. */ filter?: string; /** * The maximum number of records that should be returned. Requested page size * cannot exceed 100. If not set or set to less than or equal to 0, the * default page size is 100. . */ pageSize?: number; /** * Token identifying which result to start with, which is returned by a * previous list call. */ pageToken?: string; } /** * Additional options for Run#projectsLocationsServicesCreate. */ export interface ProjectsLocationsServicesCreateOptions { /** * Required. The unique identifier for the Service. It must begin with * letter, and cannot end with hyphen; must contain fewer than 50 characters. * The name of the service becomes {parent}/services/{service_id}. */ serviceId?: string; /** * Indicates that the request should be validated and default values * populated, without persisting the request or creating any resources. */ validateOnly?: boolean; } /** * Additional options for Run#projectsLocationsServicesDelete. */ export interface ProjectsLocationsServicesDeleteOptions { /** * A system-generated fingerprint for this version of the resource. May be * used to detect modification conflict during updates. */ etag?: string; /** * Indicates that the request should be validated without actually deleting * any resources. */ validateOnly?: boolean; } /** * Additional options for Run#projectsLocationsServicesGetIamPolicy. */ export interface ProjectsLocationsServicesGetIamPolicyOptions { /** * 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; } /** * Additional options for Run#projectsLocationsServicesList. */ export interface ProjectsLocationsServicesListOptions { /** * Maximum number of Services to return in this call. */ pageSize?: number; /** * A page token received from a previous call to ListServices. All other * parameters must match. */ pageToken?: string; /** * If true, returns deleted (but unexpired) resources along with active ones. */ showDeleted?: boolean; } /** * Additional options for Run#projectsLocationsServicesPatch. */ export interface ProjectsLocationsServicesPatchOptions { /** * Optional. If set to true, and if the Service does not exist, it will * create a new one. The caller must have 'run.services.create' permissions if * this is set to true and the Service does not exist. */ allowMissing?: boolean; /** * Optional. The list of fields to be updated. */ updateMask?: string /* FieldMask */; /** * Indicates that the request should be validated and default values * populated, without persisting the request or updating any resources. */ validateOnly?: boolean; } function serializeProjectsLocationsServicesPatchOptions(data: any): ProjectsLocationsServicesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsServicesPatchOptions(data: any): ProjectsLocationsServicesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for Run#projectsLocationsServicesRevisionsDelete. */ export interface ProjectsLocationsServicesRevisionsDeleteOptions { /** * A system-generated fingerprint for this version of the resource. This may * be used to detect modification conflict during updates. */ etag?: string; /** * Indicates that the request should be validated without actually deleting * any resources. */ validateOnly?: boolean; } /** * Additional options for Run#projectsLocationsServicesRevisionsList. */ export interface ProjectsLocationsServicesRevisionsListOptions { /** * Maximum number of revisions to return in this call. */ pageSize?: number; /** * A page token received from a previous call to ListRevisions. All other * parameters must match. */ pageToken?: string; /** * If true, returns deleted (but unexpired) resources along with active ones. */ showDeleted?: boolean; } /** * This is proto2's version of MessageSet. */ export interface Proto2BridgeMessageSet { } /** * Wire-format for a Status object */ export interface UtilStatusProto { /** * The canonical error code (see codes.proto) that most closely corresponds * to this status. This may be missing, and in the common case of the generic * space, it definitely will be. */ canonicalCode?: number; /** * Numeric code drawn from the space specified below. Often, this is the * canonical error space, and code is drawn from google3/util/task/codes.proto */ code?: number; /** * Detail message */ message?: string; /** * message_set associates an arbitrary proto message with the status. */ messageSet?: Proto2BridgeMessageSet; /** * The following are usually only present when code != 0 Space to which this * status belongs */ space?: string; } function decodeBase64(b64: string): Uint8Array { const binString = atob(b64); const size = binString.length; const bytes = new Uint8Array(size); for (let i = 0; i < size; i++) { bytes[i] = binString.charCodeAt(i); } return bytes; } const base64abc = ["A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z","a","b","c","d","e","f","g","h","i","j","k","l","m","n","o","p","q","r","s","t","u","v","w","x","y","z","0","1","2","3","4","5","6","7","8","9","+","/"]; /** * CREDIT: https://gist.github.com/enepomnyaschih/72c423f727d395eeaa09697058238727 * Encodes a given Uint8Array, ArrayBuffer or string into RFC4648 base64 representation * @param data */ function encodeBase64(uint8: Uint8Array): string { let result = "", i; const l = uint8.length; for (i = 2; i < l; i += 3) { result += base64abc[uint8[i - 2] >> 2]; result += base64abc[((uint8[i - 2] & 0x03) << 4) | (uint8[i - 1] >> 4)]; result += base64abc[((uint8[i - 1] & 0x0f) << 2) | (uint8[i] >> 6)]; result += base64abc[uint8[i] & 0x3f]; } if (i === l + 1) { // 1 octet yet to write result += base64abc[uint8[i - 2] >> 2]; result += base64abc[(uint8[i - 2] & 0x03) << 4]; result += "=="; } if (i === l) { // 2 octets yet to write result += base64abc[uint8[i - 2] >> 2]; result += base64abc[((uint8[i - 2] & 0x03) << 4) | (uint8[i - 1] >> 4)]; result += base64abc[(uint8[i - 1] & 0x0f) << 2]; result += "="; } return result; }