BatchControllerClient

BatchControllerClient

The BatchController provides methods to manage batch workloads.

Constructor

new BatchControllerClient(optionsopt, gaxInstanceopt)

Construct an instance of BatchControllerClient.

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
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.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean | "rest" <optional>

Use HTTP fallback mode. Pass "rest" to use HTTP/1.1 REST API instead of gRPC. For more information, please check the documentation.
gaxInstance gax <optional>

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 BatchControllerClient({fallback: 'rest'}, gax);

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

batchPath(project, location, batch) → {string}

Return a fully-qualified batch resource name string.

Parameters:
Name Type Description
project string
location string
batch string
Returns:
Type Description
string

Resource name string.

(async) checkCreateBatchProgress(name) → {Promise}

Check the status of the long running operation returned by createBatch().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 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 parent resource where this batch will be created.
   */
  // const parent = 'abc123'
  /**
   *  Required. The batch to create.
   */
  // const batch = {}
  /**
   *  Optional. The ID to use for the batch, which will become the final component of
   *  the batch's resource name.
   *  This value must be 4-63 characters. Valid characters are `/[a-z][0-9]-/`.
   */
  // const batchId = 'abc123'
  /**
   *  Optional. A unique ID used to identify the request. If the service
   *  receives two
   *  CreateBatchRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateBatchRequest)s
   *  with the same request_id, the second request is ignored and the
   *  Operation that corresponds to the first Batch created and stored
   *  in the backend is returned.
   *  Recommendation: Set this value to a
   *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *  The value must contain only letters (a-z, A-Z), numbers (0-9),
   *  underscores (_), and hyphens (-). The maximum length is 40 characters.
   */
  // const requestId = 'abc123'

  // Imports the Dataproc library
  const {BatchControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new BatchControllerClient();

  async function callCreateBatch() {
    // Construct request
    const request = {
      parent,
      batch,
    };

    // Run request
    const [operation] = await dataprocClient.createBatch(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateBatch();

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.

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.

listBatchesAsync(request, optionsopt) → {Object}

Equivalent to listBatches, 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
Name Type Attributes Description
parent string

Required. The parent, which owns this collection of batches.
pageSize number <optional>

Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.
pageToken string <optional>

Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.
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 Batch. 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 parent, which owns this collection of batches.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of batches to return in each response.
   *  The service may return fewer than this value.
   *  The default page size is 20; the maximum page size is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token received from a previous `ListBatches` call.
   *  Provide this token to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Dataproc library
  const {BatchControllerClient} = require('@google-cloud/dataproc').v1;

  // Instantiates a client
  const dataprocClient = new BatchControllerClient();

  async function callListBatches() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await dataprocClient.listBatchesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListBatches();

listBatchesStream(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
Name Type Attributes Description
parent string

Required. The parent, which owns this collection of batches.
pageSize number <optional>

Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.
pageToken string <optional>

Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Batch 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 listBatchesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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.

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}

Parse the autoscaling_policy from ProjectLocationAutoscalingPolicy resource.

Parameters:
Name Type Description
projectLocationAutoscalingPolicyName string

A fully-qualified path representing project_location_autoscaling_policy resource.
Returns:
Type Description
string

A string representing the autoscaling_policy.

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}

Parse the autoscaling_policy from ProjectRegionAutoscalingPolicy resource.

Parameters:
Name Type Description
projectRegionAutoscalingPolicyName string

A fully-qualified path representing project_region_autoscaling_policy resource.
Returns:
Type Description
string

A string representing the autoscaling_policy.

matchBatchFromBatchName(batchName) → {string}

Parse the batch from Batch resource.

Parameters:
Name Type Description
batchName string

A fully-qualified path representing Batch resource.
Returns:
Type Description
string

A string representing the batch.

matchClusterFromNodeGroupName(nodeGroupName) → {string}

Parse the cluster from NodeGroup resource.

Parameters:
Name Type Description
nodeGroupName string

A fully-qualified path representing NodeGroup resource.
Returns:
Type Description
string

A string representing the cluster.

matchLocationFromBatchName(batchName) → {string}

Parse the location from Batch resource.

Parameters:
Name Type Description
batchName string

A fully-qualified path representing Batch 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.

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}

Parse the location from ProjectLocationAutoscalingPolicy resource.

Parameters:
Name Type Description
projectLocationAutoscalingPolicyName string

A fully-qualified path representing project_location_autoscaling_policy resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}

Parse the location from ProjectLocationWorkflowTemplate resource.

Parameters:
Name Type Description
projectLocationWorkflowTemplateName string

A fully-qualified path representing project_location_workflow_template resource.
Returns:
Type Description
string

A string representing the location.

matchNodeGroupFromNodeGroupName(nodeGroupName) → {string}

Parse the node_group from NodeGroup resource.

Parameters:
Name Type Description
nodeGroupName string

A fully-qualified path representing NodeGroup resource.
Returns:
Type Description
string

A string representing the node_group.

matchProjectFromBatchName(batchName) → {string}

Parse the project from Batch resource.

Parameters:
Name Type Description
batchName string

A fully-qualified path representing Batch 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.

matchProjectFromNodeGroupName(nodeGroupName) → {string}

Parse the project from NodeGroup resource.

Parameters:
Name Type Description
nodeGroupName string

A fully-qualified path representing NodeGroup resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName) → {string}

Parse the project from ProjectLocationAutoscalingPolicy resource.

Parameters:
Name Type Description
projectLocationAutoscalingPolicyName string

A fully-qualified path representing project_location_autoscaling_policy resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}

Parse the project from ProjectLocationWorkflowTemplate resource.

Parameters:
Name Type Description
projectLocationWorkflowTemplateName string

A fully-qualified path representing project_location_workflow_template 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.

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}

Parse the project from ProjectRegionAutoscalingPolicy resource.

Parameters:
Name Type Description
projectRegionAutoscalingPolicyName string

A fully-qualified path representing project_region_autoscaling_policy resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}

Parse the project from ProjectRegionWorkflowTemplate resource.

Parameters:
Name Type Description
projectRegionWorkflowTemplateName string

A fully-qualified path representing project_region_workflow_template resource.
Returns:
Type Description
string

A string representing the project.

matchRegionFromNodeGroupName(nodeGroupName) → {string}

Parse the region from NodeGroup resource.

Parameters:
Name Type Description
nodeGroupName string

A fully-qualified path representing NodeGroup resource.
Returns:
Type Description
string

A string representing the region.

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName) → {string}

Parse the region from ProjectRegionAutoscalingPolicy resource.

Parameters:
Name Type Description
projectRegionAutoscalingPolicyName string

A fully-qualified path representing project_region_autoscaling_policy resource.
Returns:
Type Description
string

A string representing the region.

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}

Parse the region from ProjectRegionWorkflowTemplate resource.

Parameters:
Name Type Description
projectRegionWorkflowTemplateName string

A fully-qualified path representing project_region_workflow_template resource.
Returns:
Type Description
string

A string representing the region.

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName) → {string}

Parse the workflow_template from ProjectLocationWorkflowTemplate resource.

Parameters:
Name Type Description
projectLocationWorkflowTemplateName string

A fully-qualified path representing project_location_workflow_template resource.
Returns:
Type Description
string

A string representing the workflow_template.

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName) → {string}

Parse the workflow_template from ProjectRegionWorkflowTemplate resource.

Parameters:
Name Type Description
projectRegionWorkflowTemplateName string

A fully-qualified path representing project_region_workflow_template resource.
Returns:
Type Description
string

A string representing the workflow_template.

nodeGroupPath(project, region, cluster, node_group) → {string}

Return a fully-qualified nodeGroup resource name string.

Parameters:
Name Type Description
project string
region string
cluster string
node_group string
Returns:
Type Description
string

Resource name string.

projectLocationAutoscalingPolicyPath(project, location, autoscaling_policy) → {string}

Return a fully-qualified projectLocationAutoscalingPolicy resource name string.

Parameters:
Name Type Description
project string
location string
autoscaling_policy string
Returns:
Type Description
string

Resource name string.

projectLocationWorkflowTemplatePath(project, location, workflow_template) → {string}

Return a fully-qualified projectLocationWorkflowTemplate resource name string.

Parameters:
Name Type Description
project string
location string
workflow_template string
Returns:
Type Description
string

Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

projectRegionAutoscalingPolicyPath(project, region, autoscaling_policy) → {string}

Return a fully-qualified projectRegionAutoscalingPolicy resource name string.

Parameters:
Name Type Description
project string
region string
autoscaling_policy string
Returns:
Type Description
string

Resource name string.

projectRegionWorkflowTemplatePath(project, region, workflow_template) → {string}

Return a fully-qualified projectRegionWorkflowTemplate resource name string.

Parameters:
Name Type Description
project string
region string
workflow_template string
Returns:
Type Description
string

Resource name string.