Class v1.WorkflowsClient (2.2.0)

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Properties

apiEndpoint

static get apiEndpoint(): string;

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;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

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>>;

  /**
   * 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>>;

  /**
   * 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>>;

  /**
   * 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>;

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
    ]>;

  /**
   * 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;

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;

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
    ]>;

  /**
   * 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;

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;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): 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
    ]>;

  /**
   * 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;

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;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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
    ]>;

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;

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;

listWorkflowsAsync(request, options)

listWorkflowsAsync(request?: protos.google.cloud.workflows.v1.IListWorkflowsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.workflows.v1.IWorkflow>;

  /**
   * 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;

locationPath(project, location)

locationPath(project: string, location: string): string;

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

matchLocationFromWorkflowName(workflowName)

matchLocationFromWorkflowName(workflowName: string): string | number;

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

matchProjectFromWorkflowName(workflowName)

matchProjectFromWorkflowName(workflowName: string): string | number;

matchWorkflowFromWorkflowName(workflowName)

matchWorkflowFromWorkflowName(workflowName: string): string | number;

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
    ]>;

  /**
   * 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;

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;

workflowPath(project, location, workflow)

workflowPath(project: string, location: string, workflow: string): string;