Constructor
new RevisionsClient(optionsopt, gaxInstanceopt)
Construct an instance of RevisionsClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
cancelOperation(request, optionsopt, callbackopt) → {Promise}
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of
1, corresponding to Code.CANCELLED
.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```
(async) checkDeleteRevisionProgress(name) → {Promise}
Check the status of the long running operation returned by deleteRevision()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
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 name of the Revision to delete.
* Format:
* projects/{project}/locations/{location}/services/{service}/revisions/{revision}
*/
// 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. This may be used to detect modification conflict during updates.
*/
// const etag = 'abc123'
// Imports the Run library
const {RevisionsClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new RevisionsClient();
async function callDeleteRevision() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await runClient.deleteRevision(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteRevision();
close() → {Promise}
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves when the client is closed. |
cryptoKeyPath(project, location, key_ring, crypto_key) → {string}
Return a fully-qualified cryptoKey resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
key_ring |
string | |
crypto_key |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
deleteOperation(request, optionsopt, callbackopt) → {Promise}
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
.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```
executionPath(project, location, job, execution) → {string}
Return a fully-qualified execution resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
job |
string | |
execution |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
getLocation(request, optionsopt) → {Promise}
Gets information about a location.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Promise |
|
getOperation(request, optionsopt, callbackopt) → {Promise}
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.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing google.longrunning.Operation. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
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 | Description |
---|---|
Promise |
A promise that resolves to an authenticated service stub. |
jobPath(project, location, job) → {string}
Return a fully-qualified job resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
job |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
listLocationsAsync(request, optionsopt) → {Object}
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.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. 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, optionsopt) → {Object}
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 | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that conforms to iteration protocols. |
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```
listRevisionsAsync(request, optionsopt) → {Object}
Equivalent to listRevisions
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Revision. 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 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}
*/
// const parent = 'abc123'
/**
* Maximum number of revisions to return in this call.
*/
// const pageSize = 1234
/**
* A page token received from a previous call to ListRevisions.
* 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 {RevisionsClient} = require('@google-cloud/run').v2;
// Instantiates a client
const runClient = new RevisionsClient();
async function callListRevisions() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await runClient.listRevisionsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListRevisions();
listRevisionsStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing Revision 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 |
locationPath(project, location) → {string}
Return a fully-qualified location resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
matchCryptoKeyFromCryptoKeyName(cryptoKeyName) → {string}
Parse the crypto_key from CryptoKey resource.
Parameters:
Name | Type | Description |
---|---|---|
cryptoKeyName |
string |
A fully-qualified path representing CryptoKey resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the crypto_key. |
matchExecutionFromExecutionName(executionName) → {string}
Parse the execution from Execution resource.
Parameters:
Name | Type | Description |
---|---|---|
executionName |
string |
A fully-qualified path representing Execution resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the execution. |
matchExecutionFromTaskName(taskName) → {string}
Parse the execution from Task resource.
Parameters:
Name | Type | Description |
---|---|---|
taskName |
string |
A fully-qualified path representing Task resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the execution. |
matchJobFromExecutionName(executionName) → {string}
Parse the job from Execution resource.
Parameters:
Name | Type | Description |
---|---|---|
executionName |
string |
A fully-qualified path representing Execution resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the job. |
matchJobFromJobName(jobName) → {string}
Parse the job from Job resource.
Parameters:
Name | Type | Description |
---|---|---|
jobName |
string |
A fully-qualified path representing Job resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the job. |
matchJobFromTaskName(taskName) → {string}
Parse the job from Task resource.
Parameters:
Name | Type | Description |
---|---|---|
taskName |
string |
A fully-qualified path representing Task resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the job. |
matchKeyRingFromCryptoKeyName(cryptoKeyName) → {string}
Parse the key_ring from CryptoKey resource.
Parameters:
Name | Type | Description |
---|---|---|
cryptoKeyName |
string |
A fully-qualified path representing CryptoKey resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the key_ring. |
matchLocationFromCryptoKeyName(cryptoKeyName) → {string}
Parse the location from CryptoKey resource.
Parameters:
Name | Type | Description |
---|---|---|
cryptoKeyName |
string |
A fully-qualified path representing CryptoKey resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromExecutionName(executionName) → {string}
Parse the location from Execution resource.
Parameters:
Name | Type | Description |
---|---|---|
executionName |
string |
A fully-qualified path representing Execution resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromJobName(jobName) → {string}
Parse the location from Job resource.
Parameters:
Name | Type | Description |
---|---|---|
jobName |
string |
A fully-qualified path representing Job resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromLocationName(locationName) → {string}
Parse the location from Location resource.
Parameters:
Name | Type | Description |
---|---|---|
locationName |
string |
A fully-qualified path representing Location resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromRevisionName(revisionName) → {string}
Parse the location from Revision resource.
Parameters:
Name | Type | Description |
---|---|---|
revisionName |
string |
A fully-qualified path representing Revision resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromServiceName(serviceName) → {string}
Parse the location from Service resource.
Parameters:
Name | Type | Description |
---|---|---|
serviceName |
string |
A fully-qualified path representing Service resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromTaskName(taskName) → {string}
Parse the location from Task resource.
Parameters:
Name | Type | Description |
---|---|---|
taskName |
string |
A fully-qualified path representing Task resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchProjectFromCryptoKeyName(cryptoKeyName) → {string}
Parse the project from CryptoKey resource.
Parameters:
Name | Type | Description |
---|---|---|
cryptoKeyName |
string |
A fully-qualified path representing CryptoKey resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromExecutionName(executionName) → {string}
Parse the project from Execution resource.
Parameters:
Name | Type | Description |
---|---|---|
executionName |
string |
A fully-qualified path representing Execution resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromJobName(jobName) → {string}
Parse the project from Job resource.
Parameters:
Name | Type | Description |
---|---|---|
jobName |
string |
A fully-qualified path representing Job resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromLocationName(locationName) → {string}
Parse the project from Location resource.
Parameters:
Name | Type | Description |
---|---|---|
locationName |
string |
A fully-qualified path representing Location resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectName(projectName) → {string}
Parse the project from Project resource.
Parameters:
Name | Type | Description |
---|---|---|
projectName |
string |
A fully-qualified path representing Project resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromRevisionName(revisionName) → {string}
Parse the project from Revision resource.
Parameters:
Name | Type | Description |
---|---|---|
revisionName |
string |
A fully-qualified path representing Revision resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromServiceName(serviceName) → {string}
Parse the project from Service resource.
Parameters:
Name | Type | Description |
---|---|---|
serviceName |
string |
A fully-qualified path representing Service resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromTaskName(taskName) → {string}
Parse the project from Task resource.
Parameters:
Name | Type | Description |
---|---|---|
taskName |
string |
A fully-qualified path representing Task resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchRevisionFromRevisionName(revisionName) → {string}
Parse the revision from Revision resource.
Parameters:
Name | Type | Description |
---|---|---|
revisionName |
string |
A fully-qualified path representing Revision resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the revision. |
matchServiceFromRevisionName(revisionName) → {string}
Parse the service from Revision resource.
Parameters:
Name | Type | Description |
---|---|---|
revisionName |
string |
A fully-qualified path representing Revision resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the service. |
matchServiceFromServiceName(serviceName) → {string}
Parse the service from Service resource.
Parameters:
Name | Type | Description |
---|---|---|
serviceName |
string |
A fully-qualified path representing Service resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the service. |
matchTaskFromTaskName(taskName) → {string}
Parse the task from Task resource.
Parameters:
Name | Type | Description |
---|---|---|
taskName |
string |
A fully-qualified path representing Task resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the task. |
projectPath(project) → {string}
Return a fully-qualified project resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
revisionPath(project, location, service, revision) → {string}
Return a fully-qualified revision resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
service |
string | |
revision |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
servicePath(project, location, service) → {string}
Return a fully-qualified service resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
service |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
taskPath(project, location, job, execution, task) → {string}
Return a fully-qualified task resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
job |
string | |
execution |
string | |
task |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |