WorkflowTemplateServiceClient

WorkflowTemplateServiceClient

The API interface for managing Workflow Templates in the Cloud Dataproc API.

Constructor

new WorkflowTemplateServiceClient(optionsopt)

Construct an instance of WorkflowTemplateServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
promise function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Source:

(static) port

The port for this API service.

Source:

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

createWorkflowTemplate(request, optionsopt, callbackopt) → {Promise}

Creates new workflow template.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
template Object

Required. The Dataproc workflow template to create.

This object should have the same structure as WorkflowTemplate
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 WorkflowTemplate.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.WorkflowTemplateServiceClient({
  // optional auth parameters.
});

const formattedParent = client.regionPath('[PROJECT]', '[REGION]');
const template = {};
const request = {
  parent: formattedParent,
  template: template,
};
client.createWorkflowTemplate(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

deleteWorkflowTemplate(request, optionsopt, callbackopt) → {Promise}

Deletes a workflow template. It does not cancel in-progress workflows.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
version number <optional>

Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.
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.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.WorkflowTemplateServiceClient({
  // optional auth parameters.
});

const formattedName = client.workflowTemplatePath('[PROJECT]', '[REGION]', '[WORKFLOW_TEMPLATE]');
client.deleteWorkflowTemplate({name: formattedName}).catch(err => {
  console.error(err);
});

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

getWorkflowTemplate(request, optionsopt, callbackopt) → {Promise}

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
version number <optional>

Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.

If unspecified, retrieves the current version.
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 WorkflowTemplate.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.WorkflowTemplateServiceClient({
  // optional auth parameters.
});

const formattedName = client.workflowTemplatePath('[PROJECT]', '[REGION]', '[WORKFLOW_TEMPLATE]');
client.getWorkflowTemplate({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

instantiateInlineWorkflowTemplate(request, optionsopt, callbackopt) → {Promise}

Instantiates a template and begins execution.

This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.

The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The Operation.metadata will be WorkflowMetadata.

On successful completion, Operation.response will be Empty.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
template Object

Required. The workflow template to instantiate.

This object should have the same structure as WorkflowTemplate
instanceId string <optional>

Deprecated. Please use request_id field instead.
requestId string <optional>

Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.

It is recommended to always set this value to a UUID.

The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
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 a gax.Operation object.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.WorkflowTemplateServiceClient({
  // optional auth parameters.
});

const formattedParent = client.regionPath('[PROJECT]', '[REGION]');
const template = {};
const request = {
  parent: formattedParent,
  template: template,
};

// Handle the operation using the promise pattern.
client.instantiateInlineWorkflowTemplate(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedParent = client.regionPath('[PROJECT]', '[REGION]');
const template = {};
const request = {
  parent: formattedParent,
  template: template,
};

// Handle the operation using the event emitter pattern.
client.instantiateInlineWorkflowTemplate(request)
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedParent = client.regionPath('[PROJECT]', '[REGION]');
const template = {};
const request = {
  parent: formattedParent,
  template: template,
};

// Handle the operation using the await pattern.
const [operation] = await client.instantiateInlineWorkflowTemplate(request);

const [response] = await operation.promise();

instantiateWorkflowTemplate(request, optionsopt, callbackopt) → {Promise}

Instantiates a template and begins execution.

The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.

The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.

The Operation.metadata will be WorkflowMetadata.

On successful completion, Operation.response will be Empty.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
version number <optional>

Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.

This option cannot be used to instantiate a previous version of workflow template.
instanceId string <optional>

Deprecated. Please use request_id field instead.
requestId string <optional>

Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.

It is recommended to always set this value to a UUID.

The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
parameters Object.<string, string> <optional>

Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters.
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 a gax.Operation object.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.WorkflowTemplateServiceClient({
  // optional auth parameters.
});

const formattedName = client.workflowTemplatePath('[PROJECT]', '[REGION]', '[WORKFLOW_TEMPLATE]');

// Handle the operation using the promise pattern.
client.instantiateWorkflowTemplate({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Operation#promise starts polling for the completion of the LRO.
    return operation.promise();
  })
  .then(responses => {
    const result = responses[0];
    const metadata = responses[1];
    const finalApiResponse = responses[2];
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.workflowTemplatePath('[PROJECT]', '[REGION]', '[WORKFLOW_TEMPLATE]');

// Handle the operation using the event emitter pattern.
client.instantiateWorkflowTemplate({name: formattedName})
  .then(responses => {
    const [operation, initialApiResponse] = responses;

    // Adding a listener for the "complete" event starts polling for the
    // completion of the operation.
    operation.on('complete', (result, metadata, finalApiResponse) => {
      // doSomethingWith(result);
    });

    // Adding a listener for the "progress" event causes the callback to be
    // called on any change in metadata when the operation is polled.
    operation.on('progress', (metadata, apiResponse) => {
      // doSomethingWith(metadata)
    });

    // Adding a listener for the "error" event handles any errors found during polling.
    operation.on('error', err => {
      // throw(err);
    });
  })
  .catch(err => {
    console.error(err);
  });

const formattedName = client.workflowTemplatePath('[PROJECT]', '[REGION]', '[WORKFLOW_TEMPLATE]');

// Handle the operation using the await pattern.
const [operation] = await client.instantiateWorkflowTemplate({name: formattedName});

const [response] = await operation.promise();

listWorkflowTemplates(request, optionsopt, callbackopt) → {Promise}

Lists workflows that match the specified filter in the request.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
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 Array of WorkflowTemplate.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListWorkflowTemplatesResponse.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.WorkflowTemplateServiceClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.regionPath('[PROJECT]', '[REGION]');

client.listWorkflowTemplates({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.regionPath('[PROJECT]', '[REGION]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listWorkflowTemplates(nextRequest, options).then(callback);
  }
}
client.listWorkflowTemplates({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listWorkflowTemplatesStream(request, optionsopt) → {Stream}

Equivalent to listWorkflowTemplates, but returns a NodeJS Stream object.

This fetches the paged responses for listWorkflowTemplates continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
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.
Source:
See:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.WorkflowTemplateServiceClient({
  // optional auth parameters.
});

const formattedParent = client.regionPath('[PROJECT]', '[REGION]');
client.listWorkflowTemplatesStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

matchProjectFromRegionName(regionName) → {String}

Parse the regionName from a region resource.

Parameters:
Name Type Description
regionName String

A fully-qualified path representing a region resources.
Source:

matchProjectFromWorkflowTemplateName(workflowTemplateName) → {String}

Parse the workflowTemplateName from a workflow_template resource.

Parameters:
Name Type Description
workflowTemplateName String

A fully-qualified path representing a workflow_template resources.
Source:

matchRegionFromRegionName(regionName) → {String}

Parse the regionName from a region resource.

Parameters:
Name Type Description
regionName String

A fully-qualified path representing a region resources.
Source:

matchRegionFromWorkflowTemplateName(workflowTemplateName) → {String}

Parse the workflowTemplateName from a workflow_template resource.

Parameters:
Name Type Description
workflowTemplateName String

A fully-qualified path representing a workflow_template resources.
Source:

matchWorkflowTemplateFromWorkflowTemplateName(workflowTemplateName) → {String}

Parse the workflowTemplateName from a workflow_template resource.

Parameters:
Name Type Description
workflowTemplateName String

A fully-qualified path representing a workflow_template resources.
Source:

regionPath(project, region) → {String}

Return a fully-qualified region resource name string.

Parameters:
Name Type Description
project String
region String
Source:

updateWorkflowTemplate(request, optionsopt, callbackopt) → {Promise}

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
template Object

Required. The updated workflow template.

The template.version field must match the current version.

This object should have the same structure as WorkflowTemplate
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 WorkflowTemplate.
Source:
Example
const dataproc = require('@google-cloud/dataproc');

const client = new dataproc.v1beta2.WorkflowTemplateServiceClient({
  // optional auth parameters.
});

const template = {};
client.updateWorkflowTemplate({template: template})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

workflowTemplatePath(project, region, workflowTemplate) → {String}

Return a fully-qualified workflow_template resource name string.

Parameters:
Name Type Description
project String
region String
workflowTemplate String
Source: