Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions. v1
Package
@google-cloud/workflowsConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of WorkflowsClient.
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof gax.fallback
: loaded instance of |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (code: string, message: string, warnType?: string) => void;
workflowsStub
workflowsStub?: Promise<{
[name: string]: Function;
}>;
Methods
checkCreateWorkflowProgress(name)
checkCreateWorkflowProgress(name: string): Promise<LROperation<protos.google.cloud.workflows.v1.Workflow, protos.google.cloud.workflows.v1.OperationMetadata>>;
Check the status of the long running operation returned by createWorkflow()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.workflows.v1.Workflow, protos.google.cloud.workflows.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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. Project and location in which the workflow should be created.
* Format: projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Required. Workflow to be created.
*/
// const workflow = {}
/**
* Required. The ID of the workflow to be created. It has to fulfill the
* following requirements:
* * Must contain only letters, numbers, underscores and hyphens.
* * Must start with a letter.
* * Must be between 1-64 characters.
* * Must end with a number or a letter.
* * Must be unique within the customer project and location.
*/
// const workflowId = 'abc123'
// Imports the Workflows library
const {WorkflowsClient} = require('@google-cloud/workflows').v1;
// Instantiates a client
const workflowsClient = new WorkflowsClient();
async function callCreateWorkflow() {
// Construct request
const request = {
parent,
workflow,
workflowId,
};
// Run request
const [operation] = await workflowsClient.createWorkflow(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateWorkflow();
checkDeleteWorkflowProgress(name)
checkDeleteWorkflowProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.workflows.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteWorkflow()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.workflows.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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. Name of the workflow to be deleted.
* Format: projects/{project}/locations/{location}/workflows/{workflow}
*/
// const name = 'abc123'
// Imports the Workflows library
const {WorkflowsClient} = require('@google-cloud/workflows').v1;
// Instantiates a client
const workflowsClient = new WorkflowsClient();
async function callDeleteWorkflow() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await workflowsClient.deleteWorkflow(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteWorkflow();
checkUpdateWorkflowProgress(name)
checkUpdateWorkflowProgress(name: string): Promise<LROperation<protos.google.cloud.workflows.v1.Workflow, protos.google.cloud.workflows.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateWorkflow()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.workflows.v1.Workflow, protos.google.cloud.workflows.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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. Workflow to be updated.
*/
// const workflow = {}
/**
* List of fields to be updated. If not present, the entire workflow
* will be updated.
*/
// const updateMask = {}
// Imports the Workflows library
const {WorkflowsClient} = require('@google-cloud/workflows').v1;
// Instantiates a client
const workflowsClient = new WorkflowsClient();
async function callUpdateWorkflow() {
// Construct request
const request = {
workflow,
};
// Run request
const [operation] = await workflowsClient.updateWorkflow(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateWorkflow();
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createWorkflow(request, options)
createWorkflow(request?: protos.google.cloud.workflows.v1.ICreateWorkflowRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return error.
Name | Description |
request |
protos.google.cloud.workflows.v1.ICreateWorkflowRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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. Project and location in which the workflow should be created.
* Format: projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Required. Workflow to be created.
*/
// const workflow = {}
/**
* Required. The ID of the workflow to be created. It has to fulfill the
* following requirements:
* * Must contain only letters, numbers, underscores and hyphens.
* * Must start with a letter.
* * Must be between 1-64 characters.
* * Must end with a number or a letter.
* * Must be unique within the customer project and location.
*/
// const workflowId = 'abc123'
// Imports the Workflows library
const {WorkflowsClient} = require('@google-cloud/workflows').v1;
// Instantiates a client
const workflowsClient = new WorkflowsClient();
async function callCreateWorkflow() {
// Construct request
const request = {
parent,
workflow,
workflowId,
};
// Run request
const [operation] = await workflowsClient.createWorkflow(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateWorkflow();
createWorkflow(request, options, callback)
createWorkflow(request: protos.google.cloud.workflows.v1.ICreateWorkflowRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.ICreateWorkflowRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
createWorkflow(request, callback)
createWorkflow(request: protos.google.cloud.workflows.v1.ICreateWorkflowRequest, callback: Callback<LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.ICreateWorkflowRequest
|
callback |
Callback<LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteWorkflow(request, options)
deleteWorkflow(request?: protos.google.cloud.workflows.v1.IDeleteWorkflowRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.workflows.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.
Name | Description |
request |
protos.google.cloud.workflows.v1.IDeleteWorkflowRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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. Name of the workflow to be deleted.
* Format: projects/{project}/locations/{location}/workflows/{workflow}
*/
// const name = 'abc123'
// Imports the Workflows library
const {WorkflowsClient} = require('@google-cloud/workflows').v1;
// Instantiates a client
const workflowsClient = new WorkflowsClient();
async function callDeleteWorkflow() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await workflowsClient.deleteWorkflow(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteWorkflow();
deleteWorkflow(request, options, callback)
deleteWorkflow(request: protos.google.cloud.workflows.v1.IDeleteWorkflowRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.IDeleteWorkflowRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteWorkflow(request, callback)
deleteWorkflow(request: protos.google.cloud.workflows.v1.IDeleteWorkflowRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.IDeleteWorkflowRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Type | Description |
void |
getWorkflow(request, options)
getWorkflow(request?: protos.google.cloud.workflows.v1.IGetWorkflowRequest, options?: CallOptions): Promise<[
protos.google.cloud.workflows.v1.IWorkflow,
protos.google.cloud.workflows.v1.IGetWorkflowRequest | undefined,
{} | undefined
]>;
Gets details of a single Workflow.
Name | Description |
request |
protos.google.cloud.workflows.v1.IGetWorkflowRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IGetWorkflowRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Workflow]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* 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. Name of the workflow which information should be retrieved.
* Format: projects/{project}/locations/{location}/workflows/{workflow}
*/
// const name = 'abc123'
// Imports the Workflows library
const {WorkflowsClient} = require('@google-cloud/workflows').v1;
// Instantiates a client
const workflowsClient = new WorkflowsClient();
async function callGetWorkflow() {
// Construct request
const request = {
name,
};
// Run request
const response = await workflowsClient.getWorkflow(request);
console.log(response);
}
callGetWorkflow();
getWorkflow(request, options, callback)
getWorkflow(request: protos.google.cloud.workflows.v1.IGetWorkflowRequest, options: CallOptions, callback: Callback<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IGetWorkflowRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.IGetWorkflowRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IGetWorkflowRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getWorkflow(request, callback)
getWorkflow(request: protos.google.cloud.workflows.v1.IGetWorkflowRequest, callback: Callback<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IGetWorkflowRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.IGetWorkflowRequest
|
callback |
Callback<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IGetWorkflowRequest | null | undefined, {} | null | undefined>
|
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.
Type | Description |
Promise<{ [name: string]: Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
listWorkflows(request, options)
listWorkflows(request?: protos.google.cloud.workflows.v1.IListWorkflowsRequest, options?: CallOptions): Promise<[
protos.google.cloud.workflows.v1.IWorkflow[],
protos.google.cloud.workflows.v1.IListWorkflowsRequest | null,
protos.google.cloud.workflows.v1.IListWorkflowsResponse
]>;
Lists Workflows in a given project and location. The default order is not specified.
Name | Description |
request |
protos.google.cloud.workflows.v1.IListWorkflowsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.workflows.v1.IWorkflow[], protos.google.cloud.workflows.v1.IListWorkflowsRequest | null, protos.google.cloud.workflows.v1.IListWorkflowsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Workflow]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listWorkflows(request, options, callback)
listWorkflows(request: protos.google.cloud.workflows.v1.IListWorkflowsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.workflows.v1.IListWorkflowsRequest, protos.google.cloud.workflows.v1.IListWorkflowsResponse | null | undefined, protos.google.cloud.workflows.v1.IWorkflow>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.IListWorkflowsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.workflows.v1.IListWorkflowsRequest, protos.google.cloud.workflows.v1.IListWorkflowsResponse | null | undefined, protos.google.cloud.workflows.v1.IWorkflow>
|
Type | Description |
void |
listWorkflows(request, callback)
listWorkflows(request: protos.google.cloud.workflows.v1.IListWorkflowsRequest, callback: PaginationCallback<protos.google.cloud.workflows.v1.IListWorkflowsRequest, protos.google.cloud.workflows.v1.IListWorkflowsResponse | null | undefined, protos.google.cloud.workflows.v1.IWorkflow>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.IListWorkflowsRequest
|
callback |
PaginationCallback<protos.google.cloud.workflows.v1.IListWorkflowsRequest, protos.google.cloud.workflows.v1.IListWorkflowsResponse | null | undefined, protos.google.cloud.workflows.v1.IWorkflow>
|
Type | Description |
void |
listWorkflowsAsync(request, options)
listWorkflowsAsync(request?: protos.google.cloud.workflows.v1.IListWorkflowsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.workflows.v1.IWorkflow>;
Equivalent to listWorkflows
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.workflows.v1.IListWorkflowsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.workflows.v1.IWorkflow> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Workflow]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/**
* 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. Project and location from which the workflows should be listed.
* Format: projects/{project}/locations/{location}
*/
// const parent = 'abc123'
/**
* Maximum number of workflows to return per call. The service may return
* fewer than this value. If the value is not specified, a default value of
* 500 will be used. The maximum permitted value is 1000 and values greater
* than 1000 will be coerced down to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListWorkflows` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListWorkflows` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Filter to restrict results to specific workflows.
*/
// const filter = 'abc123'
/**
* Comma-separated list of fields that that specify the order of the results.
* Default sorting order for a field is ascending. To specify descending order
* for a field, append a " desc" suffix.
* If not specified, the results will be returned in an unspecified order.
*/
// const orderBy = 'abc123'
// Imports the Workflows library
const {WorkflowsClient} = require('@google-cloud/workflows').v1;
// Instantiates a client
const workflowsClient = new WorkflowsClient();
async function callListWorkflows() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await workflowsClient.listWorkflowsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListWorkflows();
listWorkflowsStream(request, options)
listWorkflowsStream(request?: protos.google.cloud.workflows.v1.IListWorkflowsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.workflows.v1.IListWorkflowsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Workflow] 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)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Name | Description |
project |
string
|
location |
string
|
Type | Description |
string | {string} Resource name string. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromWorkflowName(workflowName)
matchLocationFromWorkflowName(workflowName: string): string | number;
Parse the location from Workflow resource.
Name | Description |
workflowName |
string
A fully-qualified path representing Workflow resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromWorkflowName(workflowName)
matchProjectFromWorkflowName(workflowName: string): string | number;
Parse the project from Workflow resource.
Name | Description |
workflowName |
string
A fully-qualified path representing Workflow resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchWorkflowFromWorkflowName(workflowName)
matchWorkflowFromWorkflowName(workflowName: string): string | number;
Parse the workflow from Workflow resource.
Name | Description |
workflowName |
string
A fully-qualified path representing Workflow resource. |
Type | Description |
string | number | {string} A string representing the workflow. |
updateWorkflow(request, options)
updateWorkflow(request?: protos.google.cloud.workflows.v1.IUpdateWorkflowRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.
Name | Description |
request |
protos.google.cloud.workflows.v1.IUpdateWorkflowRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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. Workflow to be updated.
*/
// const workflow = {}
/**
* List of fields to be updated. If not present, the entire workflow
* will be updated.
*/
// const updateMask = {}
// Imports the Workflows library
const {WorkflowsClient} = require('@google-cloud/workflows').v1;
// Instantiates a client
const workflowsClient = new WorkflowsClient();
async function callUpdateWorkflow() {
// Construct request
const request = {
workflow,
};
// Run request
const [operation] = await workflowsClient.updateWorkflow(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateWorkflow();
updateWorkflow(request, options, callback)
updateWorkflow(request: protos.google.cloud.workflows.v1.IUpdateWorkflowRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.IUpdateWorkflowRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
updateWorkflow(request, callback)
updateWorkflow(request: protos.google.cloud.workflows.v1.IUpdateWorkflowRequest, callback: Callback<LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.workflows.v1.IUpdateWorkflowRequest
|
callback |
Callback<LROperation<protos.google.cloud.workflows.v1.IWorkflow, protos.google.cloud.workflows.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
workflowPath(project, location, workflow)
workflowPath(project: string, location: string, workflow: string): string;
Return a fully-qualified workflow resource name string.
Name | Description |
project |
string
|
location |
string
|
workflow |
string
|
Type | Description |
string | {string} Resource name string. |