Stay organized with collections Save and categorize content based on your preferences.
Cloud Run Service Control Plane API v2
Package@google-cloud/run Constructors (constructor)(opts, gaxInstance)constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of ServicesClient.
Parameters Name Descriptionopts
ClientOptions
gaxInstance
typeof gax | typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ServicesClient({fallback: true}, gax); ```
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpointstatic get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth descriptorsdescriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopesstatic get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePathstatic get servicePath(): string;
The DNS address for this API service.
servicesStubservicesStub?: Promise<{
[name: string]: Function;
}>;
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods cancelOperation(request, optionsOrCallback, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkCreateServiceProgress(name)
checkCreateServiceProgress(name: string): Promise<LROperation<protos.google.cloud.run.v2.Service, protos.google.cloud.run.v2.Service>>;
Check the status of the long running operation returned by createService()
.
name
string
The operation name that will be passed.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const parent = 'abc123'
/**
* Required. The Service instance to create.
*/
// const service = {}
/**
* 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}.
*/
// const serviceId = 'abc123'
/**
* Indicates that the request should be validated and default values
* populated, without persisting the request or creating any resources.
*/
// const validateOnly = true
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callCreateService() {
// Construct request
const request = {
parent,
service,
serviceId,
};
// Run request
const [operation] = await runClient.createService(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateService();
checkDeleteServiceProgress(name)
checkDeleteServiceProgress(name: string): Promise<LROperation<protos.google.cloud.run.v2.Service, protos.google.cloud.run.v2.Service>>;
Check the status of the long running operation returned by deleteService()
.
name
string
The operation name that will be passed.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The full name of the Service.
* Format: projects/{project}/locations/{location}/services/{service}, where
* {project} can be project id or number.
*/
// const name = 'abc123'
/**
* Indicates that the request should be validated without actually
* deleting any resources.
*/
// const validateOnly = true
/**
* A system-generated fingerprint for this version of the
* resource. May be used to detect modification conflict during updates.
*/
// const etag = 'abc123'
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callDeleteService() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await runClient.deleteService(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteService();
checkUpdateServiceProgress(name)
checkUpdateServiceProgress(name: string): Promise<LROperation<protos.google.cloud.run.v2.Service, protos.google.cloud.run.v2.Service>>;
Check the status of the long running operation returned by updateService()
.
name
string
The operation name that will be passed.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. The list of fields to be updated.
*/
// const updateMask = {}
/**
* Required. The Service to be updated.
*/
// const service = {}
/**
* Indicates that the request should be validated and default values
* populated, without persisting the request or updating any resources.
*/
// const validateOnly = true
/**
* 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.
*/
// const allowMissing = true
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callUpdateService() {
// Construct request
const request = {
service,
};
// Run request
const [operation] = await runClient.updateService(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateService();
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns Type DescriptionPromise<void>
{Promise} A promise that resolves when the client is closed.
createService(request, options)createService(request?: protos.google.cloud.run.v2.ICreateServiceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IService>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new Service in a given project and location.
Parameters Name Descriptionrequest
ICreateServiceRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const parent = 'abc123'
/**
* Required. The Service instance to create.
*/
// const service = {}
/**
* 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}.
*/
// const serviceId = 'abc123'
/**
* Indicates that the request should be validated and default values
* populated, without persisting the request or creating any resources.
*/
// const validateOnly = true
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callCreateService() {
// Construct request
const request = {
parent,
service,
serviceId,
};
// Run request
const [operation] = await runClient.createService(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateService();
createService(request, options, callback)
createService(request: protos.google.cloud.run.v2.ICreateServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IService>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns Type Description void
createService(request, callback)
createService(request: protos.google.cloud.run.v2.ICreateServiceRequest, callback: Callback<LROperation<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IService>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns Type Description void
deleteOperation(request, optionsOrCallback, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
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
.
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
deleteService(request, options)
deleteService(request?: protos.google.cloud.run.v2.IDeleteServiceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IService>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.
Parameters Name Descriptionrequest
IDeleteServiceRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The full name of the Service.
* Format: projects/{project}/locations/{location}/services/{service}, where
* {project} can be project id or number.
*/
// const name = 'abc123'
/**
* Indicates that the request should be validated without actually
* deleting any resources.
*/
// const validateOnly = true
/**
* A system-generated fingerprint for this version of the
* resource. May be used to detect modification conflict during updates.
*/
// const etag = 'abc123'
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callDeleteService() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await runClient.deleteService(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteService();
deleteService(request, options, callback)
deleteService(request: protos.google.cloud.run.v2.IDeleteServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IService>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns Type Description void
deleteService(request, callback)
deleteService(request: protos.google.cloud.run.v2.IDeleteServiceRequest, callback: Callback<LROperation<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IService>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns Type Description void
executionPath(project, location, job, execution)
executionPath(project: string, location: string, job: string, execution: string): string;
Return a fully-qualified execution resource name string.
Parameters Name Descriptionproject
string
location
string
job
string
execution
string
string
{string} Resource name string.
getIamPolicy(request, options)getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.IGetIamPolicyRequest | undefined,
{} | undefined
]>;
Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.
Parameters Name Descriptionrequest
IGetIamPolicyRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to
* `GetIamPolicy`.
*/
// const options = {}
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callGetIamPolicy() {
// Construct request
const request = {
resource,
};
// Run request
const response = await runClient.getIamPolicy(request);
console.log(response);
}
callGetIamPolicy();
getIamPolicy(request, options, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Returns Type Description void
getIamPolicy(request, callback)
getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Returns Type Description void
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
Gets information about a location.
Parameters Name Descriptionrequest
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Promise<google.cloud.location.ILocation>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example
const [response] = await client.getLocation(request);
getOperation(request, optionsOrCallback, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Example
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getProjectId()
getProjectId(): Promise<string>;
Returns Type Description Promise<string>
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter Name Description callback
Callback<string, undefined, undefined>
void
getService(request, options)
getService(request?: protos.google.cloud.run.v2.IGetServiceRequest, options?: CallOptions): Promise<[
protos.google.cloud.run.v2.IService,
protos.google.cloud.run.v2.IGetServiceRequest | undefined,
{} | undefined
]>;
Gets information about a Service.
Parameters Name Descriptionrequest
IGetServiceRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The full name of the Service.
* Format: projects/{project}/locations/{location}/services/{service}, where
* {project} can be project id or number.
*/
// const name = 'abc123'
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callGetService() {
// Construct request
const request = {
name,
};
// Run request
const response = await runClient.getService(request);
console.log(response);
}
callGetService();
getService(request, options, callback)
getService(request: protos.google.cloud.run.v2.IGetServiceRequest, options: CallOptions, callback: Callback<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
Returns Type Description void
getService(request, callback)
getService(request: protos.google.cloud.run.v2.IGetServiceRequest, callback: Callback<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
Returns Type Description void
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns Type DescriptionPromise<{ [name: string]: Function; }>
{Promise} A promise that resolves to an authenticated service stub.
jobPath(project, location, job)jobPath(project: string, location: string, job: string): string;
Return a fully-qualified job resource name string.
Parameters Name Descriptionproject
string
location
string
job
string
string
{string} Resource name string.
listLocationsAsync(request, options)listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
Lists information about the supported locations for this service. Returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
Returns Type DescriptionAsyncIterable<google.cloud.location.ILocation>
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters Name Descriptionrequest
ListOperationsRequest
The request object that will be sent.
options
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Example
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
listServices(request, options)
listServices(request?: protos.google.cloud.run.v2.IListServicesRequest, options?: CallOptions): Promise<[
protos.google.cloud.run.v2.IService[],
protos.google.cloud.run.v2.IListServicesRequest | null,
protos.google.cloud.run.v2.IListServicesResponse
]>;
Lists Services. Results are sorted by creation time, descending.
Parameters Name Descriptionrequest
IListServicesRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
listServices(request, options, callback)listServices(request: protos.google.cloud.run.v2.IListServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.run.v2.IListServicesRequest, protos.google.cloud.run.v2.IListServicesResponse | null | undefined, protos.google.cloud.run.v2.IService>): void;
Returns Type Description void
listServices(request, callback)
listServices(request: protos.google.cloud.run.v2.IListServicesRequest, callback: PaginationCallback<protos.google.cloud.run.v2.IListServicesRequest, protos.google.cloud.run.v2.IListServicesResponse | null | undefined, protos.google.cloud.run.v2.IService>): void;
Returns Type Description void
listServicesAsync(request, options)
listServicesAsync(request?: protos.google.cloud.run.v2.IListServicesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.run.v2.IService>;
Equivalent to listServices
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
request
IListServicesRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
Returns Type DescriptionAsyncIterable<protos.google.cloud.run.v2.IService>
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Service. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const parent = 'abc123'
/**
* Maximum number of Services to return in this call.
*/
// const pageSize = 1234
/**
* A page token received from a previous call to ListServices.
* All other parameters must match.
*/
// const pageToken = 'abc123'
/**
* If true, returns deleted (but unexpired) resources along with active ones.
*/
// const showDeleted = true
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callListServices() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = runClient.listServicesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListServices();
listServicesStream(request, options)
listServicesStream(request?: protos.google.cloud.run.v2.IListServicesRequest, options?: CallOptions): Transform;
Equivalent to listServices
, but returns a NodeJS Stream object.
request
IListServicesRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
Returns Type DescriptionTransform
{Stream} An object stream which emits an object representing Service on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listServicesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Parameters Name Descriptionproject
string
location
string
string
{string} Resource name string.
matchExecutionFromExecutionName(executionName)matchExecutionFromExecutionName(executionName: string): string | number;
Parse the execution from Execution resource.
Parameter Name DescriptionexecutionName
string
A fully-qualified path representing Execution resource.
Returns Type Descriptionstring | number
{string} A string representing the execution.
matchExecutionFromTaskName(taskName)matchExecutionFromTaskName(taskName: string): string | number;
Parse the execution from Task resource.
Parameter Name DescriptiontaskName
string
A fully-qualified path representing Task resource.
Returns Type Descriptionstring | number
{string} A string representing the execution.
matchJobFromExecutionName(executionName)matchJobFromExecutionName(executionName: string): string | number;
Parse the job from Execution resource.
Parameter Name DescriptionexecutionName
string
A fully-qualified path representing Execution resource.
Returns Type Descriptionstring | number
{string} A string representing the job.
matchJobFromJobName(jobName)matchJobFromJobName(jobName: string): string | number;
Parse the job from Job resource.
Parameter Name DescriptionjobName
string
A fully-qualified path representing Job resource.
Returns Type Descriptionstring | number
{string} A string representing the job.
matchJobFromTaskName(taskName)matchJobFromTaskName(taskName: string): string | number;
Parse the job from Task resource.
Parameter Name DescriptiontaskName
string
A fully-qualified path representing Task resource.
Returns Type Descriptionstring | number
{string} A string representing the job.
matchLocationFromExecutionName(executionName)matchLocationFromExecutionName(executionName: string): string | number;
Parse the location from Execution resource.
Parameter Name DescriptionexecutionName
string
A fully-qualified path representing Execution resource.
Returns Type Descriptionstring | number
{string} A string representing the location.
matchLocationFromJobName(jobName)matchLocationFromJobName(jobName: string): string | number;
Parse the location from Job resource.
Parameter Name DescriptionjobName
string
A fully-qualified path representing Job resource.
Returns Type Descriptionstring | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Parameter Name DescriptionlocationName
string
A fully-qualified path representing Location resource.
Returns Type Descriptionstring | number
{string} A string representing the location.
matchLocationFromRevisionName(revisionName)matchLocationFromRevisionName(revisionName: string): string | number;
Parse the location from Revision resource.
Parameter Name DescriptionrevisionName
string
A fully-qualified path representing Revision resource.
Returns Type Descriptionstring | number
{string} A string representing the location.
matchLocationFromServiceName(serviceName)matchLocationFromServiceName(serviceName: string): string | number;
Parse the location from Service resource.
Parameter Name DescriptionserviceName
string
A fully-qualified path representing Service resource.
Returns Type Descriptionstring | number
{string} A string representing the location.
matchLocationFromTaskName(taskName)matchLocationFromTaskName(taskName: string): string | number;
Parse the location from Task resource.
Parameter Name DescriptiontaskName
string
A fully-qualified path representing Task resource.
Returns Type Descriptionstring | number
{string} A string representing the location.
matchProjectFromExecutionName(executionName)matchProjectFromExecutionName(executionName: string): string | number;
Parse the project from Execution resource.
Parameter Name DescriptionexecutionName
string
A fully-qualified path representing Execution resource.
Returns Type Descriptionstring | number
{string} A string representing the project.
matchProjectFromJobName(jobName)matchProjectFromJobName(jobName: string): string | number;
Parse the project from Job resource.
Parameter Name DescriptionjobName
string
A fully-qualified path representing Job resource.
Returns Type Descriptionstring | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Parameter Name DescriptionlocationName
string
A fully-qualified path representing Location resource.
Returns Type Descriptionstring | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Parameter Name DescriptionprojectName
string
A fully-qualified path representing Project resource.
Returns Type Descriptionstring | number
{string} A string representing the project.
matchProjectFromRevisionName(revisionName)matchProjectFromRevisionName(revisionName: string): string | number;
Parse the project from Revision resource.
Parameter Name DescriptionrevisionName
string
A fully-qualified path representing Revision resource.
Returns Type Descriptionstring | number
{string} A string representing the project.
matchProjectFromServiceName(serviceName)matchProjectFromServiceName(serviceName: string): string | number;
Parse the project from Service resource.
Parameter Name DescriptionserviceName
string
A fully-qualified path representing Service resource.
Returns Type Descriptionstring | number
{string} A string representing the project.
matchProjectFromTaskName(taskName)matchProjectFromTaskName(taskName: string): string | number;
Parse the project from Task resource.
Parameter Name DescriptiontaskName
string
A fully-qualified path representing Task resource.
Returns Type Descriptionstring | number
{string} A string representing the project.
matchRevisionFromRevisionName(revisionName)matchRevisionFromRevisionName(revisionName: string): string | number;
Parse the revision from Revision resource.
Parameter Name DescriptionrevisionName
string
A fully-qualified path representing Revision resource.
Returns Type Descriptionstring | number
{string} A string representing the revision.
matchServiceFromRevisionName(revisionName)matchServiceFromRevisionName(revisionName: string): string | number;
Parse the service from Revision resource.
Parameter Name DescriptionrevisionName
string
A fully-qualified path representing Revision resource.
Returns Type Descriptionstring | number
{string} A string representing the service.
matchServiceFromServiceName(serviceName)matchServiceFromServiceName(serviceName: string): string | number;
Parse the service from Service resource.
Parameter Name DescriptionserviceName
string
A fully-qualified path representing Service resource.
Returns Type Descriptionstring | number
{string} A string representing the service.
matchTaskFromTaskName(taskName)matchTaskFromTaskName(taskName: string): string | number;
Parse the task from Task resource.
Parameter Name DescriptiontaskName
string
A fully-qualified path representing Task resource.
Returns Type Descriptionstring | number
{string} A string representing the task.
projectPath(project)projectPath(project: string): string;
Return a fully-qualified project resource name string.
Parameter Name Descriptionproject
string
string
{string} Resource name string.
revisionPath(project, location, service, revision)revisionPath(project: string, location: string, service: string, revision: string): string;
Return a fully-qualified revision resource name string.
Parameters Name Descriptionproject
string
location
string
service
string
revision
string
string
{string} Resource name string.
servicePath(project, location, service)servicePath(project: string, location: string, service: string): string;
Return a fully-qualified service resource name string.
Parameters Name Descriptionproject
string
location
string
service
string
string
{string} Resource name string.
setIamPolicy(request, options)setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
protos.google.iam.v1.IPolicy,
protos.google.iam.v1.ISetIamPolicyRequest | undefined,
{} | undefined
]>;
Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.
Parameters Name Descriptionrequest
ISetIamPolicyRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* 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 Cloud Platform services (such as Projects)
* might reject them.
*/
// const policy = {}
/**
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
* the fields in the mask will be modified. If no mask is provided, the
* following default mask is used:
* `paths: "bindings, etag"`
*/
// const updateMask = {}
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callSetIamPolicy() {
// Construct request
const request = {
resource,
policy,
};
// Run request
const response = await runClient.setIamPolicy(request);
console.log(response);
}
callSetIamPolicy();
setIamPolicy(request, options, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Returns Type Description void
setIamPolicy(request, callback)
setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Returns Type Description void
taskPath(project, location, job, execution, task)
taskPath(project: string, location: string, job: string, execution: string, task: string): string;
Return a fully-qualified task resource name string.
Parameters Name Descriptionproject
string
location
string
job
string
execution
string
task
string
string
{string} Resource name string.
testIamPermissions(request, options)testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[
protos.google.iam.v1.ITestIamPermissionsResponse,
protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
{} | undefined
]>;
Returns permissions that a caller has on the specified Project.
There are no permissions required for making this API call.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
*/
// const resource = 'abc123'
/**
* 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).
*/
// const permissions = ['abc','def']
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callTestIamPermissions() {
// Construct request
const request = {
resource,
permissions,
};
// Run request
const response = await runClient.testIamPermissions(request);
console.log(response);
}
callTestIamPermissions();
testIamPermissions(request, options, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Returns Type Description void
testIamPermissions(request, callback)
testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Returns Type Description void
updateService(request, options)
updateService(request?: protos.google.cloud.run.v2.IUpdateServiceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IService>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates a Service.
Parameters Name Descriptionrequest
IUpdateServiceRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions for more details.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Optional. The list of fields to be updated.
*/
// const updateMask = {}
/**
* Required. The Service to be updated.
*/
// const service = {}
/**
* Indicates that the request should be validated and default values
* populated, without persisting the request or updating any resources.
*/
// const validateOnly = true
/**
* 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.
*/
// const allowMissing = true
// Imports the Run library
const {ServicesClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new ServicesClient();
async function callUpdateService() {
// Construct request
const request = {
service,
};
// Run request
const [operation] = await runClient.updateService(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateService();
updateService(request, options, callback)
updateService(request: protos.google.cloud.run.v2.IUpdateServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IService>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns Type Description void
updateService(request, callback)
updateService(request: protos.google.cloud.run.v2.IUpdateServiceRequest, callback: Callback<LROperation<protos.google.cloud.run.v2.IService, protos.google.cloud.run.v2.IService>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns Type Description void
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4