Class v1.BatchControllerClient (3.2.0)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

batchControllerStub

batchControllerStub?: Promise<{
        [name: string]: Function;
    }>;

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;

Methods

batchPath(project, location, batch)

batchPath(project: string, location: string, batch: string): string;

checkCreateBatchProgress(name)

checkCreateBatchProgress(name: string): Promise<LROperation<protos.google.cloud.dataproc.v1.Batch, protos.google.cloud.dataproc.v1.BatchOperationMetadata>>;

  /**
   * 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()

close(): Promise<void>;

createBatch(request, options)

createBatch(request?: protos.google.cloud.dataproc.v1.ICreateBatchRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.dataproc.v1.IBatch, protos.google.cloud.dataproc.v1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

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

createBatch(request, options, callback)

createBatch(request: protos.google.cloud.dataproc.v1.ICreateBatchRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dataproc.v1.IBatch, protos.google.cloud.dataproc.v1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

createBatch(request, callback)

createBatch(request: protos.google.cloud.dataproc.v1.ICreateBatchRequest, callback: Callback<LROperation<protos.google.cloud.dataproc.v1.IBatch, protos.google.cloud.dataproc.v1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

deleteBatch(request, options)

deleteBatch(request?: protos.google.cloud.dataproc.v1.IDeleteBatchRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteBatchRequest | undefined, {} | undefined]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the batch resource to delete.
   */
  // const name = 'abc123'

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

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

  async function callDeleteBatch() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await dataprocClient.deleteBatch(request);
    console.log(response);
  }

  callDeleteBatch();

deleteBatch(request, options, callback)

deleteBatch(request: protos.google.cloud.dataproc.v1.IDeleteBatchRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteBatchRequest | null | undefined, {} | null | undefined>): void;

deleteBatch(request, callback)

deleteBatch(request: protos.google.cloud.dataproc.v1.IDeleteBatchRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dataproc.v1.IDeleteBatchRequest | null | undefined, {} | null | undefined>): void;

getBatch(request, options)

getBatch(request?: protos.google.cloud.dataproc.v1.IGetBatchRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IBatch, protos.google.cloud.dataproc.v1.IGetBatchRequest | undefined, {} | undefined]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the batch to retrieve.
   */
  // const name = 'abc123'

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

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

  async function callGetBatch() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await dataprocClient.getBatch(request);
    console.log(response);
  }

  callGetBatch();

getBatch(request, options, callback)

getBatch(request: protos.google.cloud.dataproc.v1.IGetBatchRequest, options: CallOptions, callback: Callback<protos.google.cloud.dataproc.v1.IBatch, protos.google.cloud.dataproc.v1.IGetBatchRequest | null | undefined, {} | null | undefined>): void;

getBatch(request, callback)

getBatch(request: protos.google.cloud.dataproc.v1.IGetBatchRequest, callback: Callback<protos.google.cloud.dataproc.v1.IBatch, protos.google.cloud.dataproc.v1.IGetBatchRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

initialize()

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

listBatches(request, options)

listBatches(request?: protos.google.cloud.dataproc.v1.IListBatchesRequest, options?: CallOptions): Promise<[protos.google.cloud.dataproc.v1.IBatch[], protos.google.cloud.dataproc.v1.IListBatchesRequest | null, protos.google.cloud.dataproc.v1.IListBatchesResponse]>;

listBatches(request, options, callback)

listBatches(request: protos.google.cloud.dataproc.v1.IListBatchesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dataproc.v1.IListBatchesRequest, protos.google.cloud.dataproc.v1.IListBatchesResponse | null | undefined, protos.google.cloud.dataproc.v1.IBatch>): void;

listBatches(request, callback)

listBatches(request: protos.google.cloud.dataproc.v1.IListBatchesRequest, callback: PaginationCallback<protos.google.cloud.dataproc.v1.IListBatchesRequest, protos.google.cloud.dataproc.v1.IListBatchesResponse | null | undefined, protos.google.cloud.dataproc.v1.IBatch>): void;

listBatchesAsync(request, options)

listBatchesAsync(request?: protos.google.cloud.dataproc.v1.IListBatchesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dataproc.v1.IBatch>;

  /**
   * 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, options)

listBatchesStream(request?: protos.google.cloud.dataproc.v1.IListBatchesRequest, options?: CallOptions): Transform;

locationPath(project, location)

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

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

matchBatchFromBatchName(batchName)

matchBatchFromBatchName(batchName: string): string | number;

matchLocationFromBatchName(batchName)

matchLocationFromBatchName(batchName: string): string | number;

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

matchProjectFromBatchName(batchName)

matchProjectFromBatchName(batchName: string): string | number;

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName: string): string | number;

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName: string): string | number;

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName: string): string | number;

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName: string): string | number;

projectLocationAutoscalingPolicyPath(project, location, autoscalingPolicy)

projectLocationAutoscalingPolicyPath(project: string, location: string, autoscalingPolicy: string): string;

projectLocationWorkflowTemplatePath(project, location, workflowTemplate)

projectLocationWorkflowTemplatePath(project: string, location: string, workflowTemplate: string): string;

projectPath(project)

projectPath(project: string): string;

projectRegionAutoscalingPolicyPath(project, region, autoscalingPolicy)

projectRegionAutoscalingPolicyPath(project: string, region: string, autoscalingPolicy: string): string;

projectRegionWorkflowTemplatePath(project, region, workflowTemplate)

projectRegionWorkflowTemplatePath(project: string, region: string, workflowTemplate: string): string;