Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Run

import { Run } from "https://googleapis.deno.dev/v1/run:v2.ts";

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/.

class Run {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsLocationsExportImage(name: string, req: GoogleCloudRunV2ExportImageRequest): Promise<GoogleCloudRunV2ExportImageResponse>;
async projectsLocationsExportImageMetadata(name: string): Promise<GoogleCloudRunV2Metadata>;
async projectsLocationsExportMetadata(name: string): Promise<GoogleCloudRunV2Metadata>;
async projectsLocationsJobsCreate(
parent: string,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsJobsDelete(name: string, opts?: ProjectsLocationsJobsDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsJobsExecutionsCancel(name: string, req: GoogleCloudRunV2CancelExecutionRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsJobsExecutionsDelete(name: string, opts?: ProjectsLocationsJobsExecutionsDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsJobsExecutionsExportStatus(name: string, operationId: string): Promise<GoogleCloudRunV2ExportStatusResponse>;
async projectsLocationsJobsExecutionsGet(name: string): Promise<GoogleCloudRunV2Execution>;
async projectsLocationsJobsExecutionsList(parent: string, opts?: ProjectsLocationsJobsExecutionsListOptions): Promise<GoogleCloudRunV2ListExecutionsResponse>;
async projectsLocationsJobsExecutionsTasksGet(name: string): Promise<GoogleCloudRunV2Task>;
async projectsLocationsJobsExecutionsTasksList(parent: string, opts?: ProjectsLocationsJobsExecutionsTasksListOptions): Promise<GoogleCloudRunV2ListTasksResponse>;
async projectsLocationsJobsGet(name: string): Promise<GoogleCloudRunV2Job>;
async projectsLocationsJobsGetIamPolicy(resource: string, opts?: ProjectsLocationsJobsGetIamPolicyOptions): Promise<GoogleIamV1Policy>;
async projectsLocationsJobsList(parent: string, opts?: ProjectsLocationsJobsListOptions): Promise<GoogleCloudRunV2ListJobsResponse>;
async projectsLocationsJobsPatch(
name: string,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsJobsRun(name: string, req: GoogleCloudRunV2RunJobRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsJobsSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>;
async projectsLocationsJobsTestIamPermissions(resource: string, req: GoogleIamV1TestIamPermissionsRequest): Promise<GoogleIamV1TestIamPermissionsResponse>;
async projectsLocationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsOperationsWait(name: string, req: GoogleLongrunningWaitOperationRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsServicesCreate(
parent: string,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsServicesDelete(name: string, opts?: ProjectsLocationsServicesDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsServicesGet(name: string): Promise<GoogleCloudRunV2Service>;
async projectsLocationsServicesGetIamPolicy(resource: string, opts?: ProjectsLocationsServicesGetIamPolicyOptions): Promise<GoogleIamV1Policy>;
async projectsLocationsServicesList(parent: string, opts?: ProjectsLocationsServicesListOptions): Promise<GoogleCloudRunV2ListServicesResponse>;
async projectsLocationsServicesPatch(
name: string,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsServicesRevisionsDelete(name: string, opts?: ProjectsLocationsServicesRevisionsDeleteOptions): Promise<GoogleLongrunningOperation>;
async projectsLocationsServicesRevisionsExportStatus(name: string, operationId: string): Promise<GoogleCloudRunV2ExportStatusResponse>;
async projectsLocationsServicesRevisionsGet(name: string): Promise<GoogleCloudRunV2Revision>;
async projectsLocationsServicesRevisionsList(parent: string, opts?: ProjectsLocationsServicesRevisionsListOptions): Promise<GoogleCloudRunV2ListRevisionsResponse>;
async projectsLocationsServicesSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>;
async projectsLocationsServicesTestIamPermissions(resource: string, req: GoogleIamV1TestIamPermissionsRequest): Promise<GoogleIamV1TestIamPermissionsResponse>;
}

§Constructors

§
new Run(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
projectsLocationsExportImage(name: string, req: GoogleCloudRunV2ExportImageRequest): Promise<GoogleCloudRunV2ExportImageResponse>
[src]

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

§
projectsLocationsExportImageMetadata(name: string): Promise<GoogleCloudRunV2Metadata>
[src]

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

§
projectsLocationsExportMetadata(name: string): Promise<GoogleCloudRunV2Metadata>
[src]

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

§
projectsLocationsJobsCreate(parent: string, req: GoogleCloudRunV2Job, opts?: ProjectsLocationsJobsCreateOptions): Promise<GoogleLongrunningOperation>
[src]

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.

§
projectsLocationsJobsDelete(name: string, opts?: ProjectsLocationsJobsDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

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.

§
projectsLocationsJobsExecutionsCancel(name: string, req: GoogleCloudRunV2CancelExecutionRequest): Promise<GoogleLongrunningOperation>
[src]

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.

§
projectsLocationsJobsExecutionsDelete(name: string, opts?: ProjectsLocationsJobsExecutionsDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

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.

§
projectsLocationsJobsExecutionsExportStatus(name: string, operationId: string): Promise<GoogleCloudRunV2ExportStatusResponse>
[src]

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.

§
projectsLocationsJobsExecutionsGet(name: string): Promise<GoogleCloudRunV2Execution>
[src]

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.

§
projectsLocationsJobsExecutionsList(parent: string, opts?: ProjectsLocationsJobsExecutionsListOptions): Promise<GoogleCloudRunV2ListExecutionsResponse>
[src]

Lists Executions from a Job.

@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.

§
projectsLocationsJobsExecutionsTasksGet(name: string): Promise<GoogleCloudRunV2Task>
[src]

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}

§
projectsLocationsJobsExecutionsTasksList(parent: string, opts?: ProjectsLocationsJobsExecutionsTasksListOptions): Promise<GoogleCloudRunV2ListTasksResponse>
[src]

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}

§
projectsLocationsJobsGet(name: string): Promise<GoogleCloudRunV2Job>
[src]

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.

§
projectsLocationsJobsGetIamPolicy(resource: string, opts?: ProjectsLocationsJobsGetIamPolicyOptions): Promise<GoogleIamV1Policy>
[src]

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 for the appropriate value for this field.

§
projectsLocationsJobsList(parent: string, opts?: ProjectsLocationsJobsListOptions): Promise<GoogleCloudRunV2ListJobsResponse>
[src]

Lists Jobs.

@param parent

Required. The location and project to list resources on. Format: projects/{project}/locations/{location}, where {project} can be project id or number.

§
projectsLocationsJobsPatch(name: string, req: GoogleCloudRunV2Job, opts?: ProjectsLocationsJobsPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates a Job.

@param name

The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}

§
projectsLocationsJobsRun(name: string, req: GoogleCloudRunV2RunJobRequest): Promise<GoogleLongrunningOperation>
[src]

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.

§
projectsLocationsJobsSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>
[src]

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 for the appropriate value for this field.

§
projectsLocationsJobsTestIamPermissions(resource: string, req: GoogleIamV1TestIamPermissionsRequest): Promise<GoogleIamV1TestIamPermissionsResponse>
[src]

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 for the appropriate value for this field.

§
projectsLocationsOperationsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

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.

§
projectsLocationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

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.

§
projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

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.

§
projectsLocationsOperationsWait(name: string, req: GoogleLongrunningWaitOperationRequest): Promise<GoogleLongrunningOperation>
[src]

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.

§
projectsLocationsServicesCreate(parent: string, req: GoogleCloudRunV2Service, opts?: ProjectsLocationsServicesCreateOptions): Promise<GoogleLongrunningOperation>
[src]

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.

§
projectsLocationsServicesDelete(name: string, opts?: ProjectsLocationsServicesDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

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.

§
projectsLocationsServicesGet(name: string): Promise<GoogleCloudRunV2Service>
[src]

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.

§
projectsLocationsServicesGetIamPolicy(resource: string, opts?: ProjectsLocationsServicesGetIamPolicyOptions): Promise<GoogleIamV1Policy>
[src]

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 for the appropriate value for this field.

§
projectsLocationsServicesList(parent: string, opts?: ProjectsLocationsServicesListOptions): Promise<GoogleCloudRunV2ListServicesResponse>
[src]

Lists Services.

@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.

§
projectsLocationsServicesPatch(name: string, req: GoogleCloudRunV2Service, opts?: ProjectsLocationsServicesPatchOptions): Promise<GoogleLongrunningOperation>
[src]

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}

§
projectsLocationsServicesRevisionsDelete(name: string, opts?: ProjectsLocationsServicesRevisionsDeleteOptions): Promise<GoogleLongrunningOperation>
[src]

Deletes a Revision.

@param name

Required. The name of the Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}

§
projectsLocationsServicesRevisionsExportStatus(name: string, operationId: string): Promise<GoogleCloudRunV2ExportStatusResponse>
[src]

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.

§
projectsLocationsServicesRevisionsGet(name: string): Promise<GoogleCloudRunV2Revision>
[src]

Gets information about a Revision.

@param name

Required. The full name of the Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}

§
projectsLocationsServicesRevisionsList(parent: string, opts?: ProjectsLocationsServicesRevisionsListOptions): Promise<GoogleCloudRunV2ListRevisionsResponse>
[src]

Lists Revisions from a given Service, or from a given location.

@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}

§
projectsLocationsServicesSetIamPolicy(resource: string, req: GoogleIamV1SetIamPolicyRequest): Promise<GoogleIamV1Policy>
[src]

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 for the appropriate value for this field.

§
projectsLocationsServicesTestIamPermissions(resource: string, req: GoogleIamV1TestIamPermissionsRequest): Promise<GoogleIamV1TestIamPermissionsResponse>
[src]

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 for the appropriate value for this field.