Class v1beta3.JobsV1Beta3Client

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

jobsV1Beta3Stub

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

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

aggregatedListJobs(request, options)

aggregatedListJobs(request?: protos.google.dataflow.v1beta3.IListJobsRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IJob[],
        protos.google.dataflow.v1beta3.IListJobsRequest | null,
        protos.google.dataflow.v1beta3.IListJobsResponse
    ]>;

aggregatedListJobs(request, options, callback)

aggregatedListJobs(request: protos.google.dataflow.v1beta3.IListJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.dataflow.v1beta3.IListJobsRequest, protos.google.dataflow.v1beta3.IListJobsResponse | null | undefined, protos.google.dataflow.v1beta3.IJob>): void;

aggregatedListJobs(request, callback)

aggregatedListJobs(request: protos.google.dataflow.v1beta3.IListJobsRequest, callback: PaginationCallback<protos.google.dataflow.v1beta3.IListJobsRequest, protos.google.dataflow.v1beta3.IListJobsResponse | null | undefined, protos.google.dataflow.v1beta3.IJob>): void;

aggregatedListJobsAsync(request, options)

aggregatedListJobsAsync(request?: protos.google.dataflow.v1beta3.IListJobsRequest, options?: CallOptions): AsyncIterable<protos.google.dataflow.v1beta3.IJob>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The kind of filter to use.
   */
  // const filter = {}
  /**
   *  The project which owns the jobs.
   */
  // const projectId = 'abc123'
  /**
   *  If there are many jobs, limit response to at most this many.
   *  The actual number of jobs returned will be the lesser of max_responses
   *  and an unspecified server-defined limit.
   */
  // const pageSize = 1234
  /**
   *  Set this to the 'next_page_token' field of a previous response
   *  to request additional results in a long list.
   */
  // const pageToken = 'abc123'
  /**
   *  The regional endpoint
   *  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
   *  contains this job.
   */
  // const location = 'abc123'

  // Imports the Dataflow library
  const {JobsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;

  // Instantiates a client
  const dataflowClient = new JobsV1Beta3Client();

  async function callAggregatedListJobs() {
    // Construct request
    const request = {};

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

  callAggregatedListJobs();

aggregatedListJobsStream(request, options)

aggregatedListJobsStream(request?: protos.google.dataflow.v1beta3.IListJobsRequest, options?: CallOptions): Transform;

checkActiveJobs(request, options)

checkActiveJobs(request?: protos.google.dataflow.v1beta3.ICheckActiveJobsRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.ICheckActiveJobsResponse,
        protos.google.dataflow.v1beta3.ICheckActiveJobsRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The project which owns the jobs.
   */
  // const projectId = 'abc123'

  // Imports the Dataflow library
  const {JobsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;

  // Instantiates a client
  const dataflowClient = new JobsV1Beta3Client();

  async function callCheckActiveJobs() {
    // Construct request
    const request = {};

    // Run request
    const response = await dataflowClient.checkActiveJobs(request);
    console.log(response);
  }

  callCheckActiveJobs();

checkActiveJobs(request, options, callback)

checkActiveJobs(request: protos.google.dataflow.v1beta3.ICheckActiveJobsRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.ICheckActiveJobsResponse, protos.google.dataflow.v1beta3.ICheckActiveJobsRequest | null | undefined, {} | null | undefined>): void;

checkActiveJobs(request, callback)

checkActiveJobs(request: protos.google.dataflow.v1beta3.ICheckActiveJobsRequest, callback: Callback<protos.google.dataflow.v1beta3.ICheckActiveJobsResponse, protos.google.dataflow.v1beta3.ICheckActiveJobsRequest | null | undefined, {} | null | undefined>): void;

close()

close(): Promise<void>;

createJob(request, options)

createJob(request?: protos.google.dataflow.v1beta3.ICreateJobRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IJob,
        protos.google.dataflow.v1beta3.ICreateJobRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The ID of the Cloud Platform project that the job belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  The job to create.
   */
  // const job = {}
  /**
   *  The level of information requested in response.
   */
  // const view = {}
  /**
   *  The regional endpoint
   *  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
   *  contains this job.
   */
  // const location = 'abc123'

  // Imports the Dataflow library
  const {JobsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;

  // Instantiates a client
  const dataflowClient = new JobsV1Beta3Client();

  async function callCreateJob() {
    // Construct request
    const request = {};

    // Run request
    const response = await dataflowClient.createJob(request);
    console.log(response);
  }

  callCreateJob();

createJob(request, options, callback)

createJob(request: protos.google.dataflow.v1beta3.ICreateJobRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.ICreateJobRequest | null | undefined, {} | null | undefined>): void;

createJob(request, callback)

createJob(request: protos.google.dataflow.v1beta3.ICreateJobRequest, callback: Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.ICreateJobRequest | null | undefined, {} | null | undefined>): void;

getJob(request, options)

getJob(request?: protos.google.dataflow.v1beta3.IGetJobRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IJob,
        protos.google.dataflow.v1beta3.IGetJobRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The ID of the Cloud Platform project that the job belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  The job ID.
   */
  // const jobId = 'abc123'
  /**
   *  The level of information requested in response.
   */
  // const view = {}
  /**
   *  The regional endpoint
   *  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
   *  contains this job.
   */
  // const location = 'abc123'

  // Imports the Dataflow library
  const {JobsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;

  // Instantiates a client
  const dataflowClient = new JobsV1Beta3Client();

  async function callGetJob() {
    // Construct request
    const request = {};

    // Run request
    const response = await dataflowClient.getJob(request);
    console.log(response);
  }

  callGetJob();

getJob(request, options, callback)

getJob(request: protos.google.dataflow.v1beta3.IGetJobRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.IGetJobRequest | null | undefined, {} | null | undefined>): void;

getJob(request, callback)

getJob(request: protos.google.dataflow.v1beta3.IGetJobRequest, callback: Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.IGetJobRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

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

initialize()

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

listJobs(request, options)

listJobs(request?: protos.google.dataflow.v1beta3.IListJobsRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IJob[],
        protos.google.dataflow.v1beta3.IListJobsRequest | null,
        protos.google.dataflow.v1beta3.IListJobsResponse
    ]>;

listJobs(request, options, callback)

listJobs(request: protos.google.dataflow.v1beta3.IListJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.dataflow.v1beta3.IListJobsRequest, protos.google.dataflow.v1beta3.IListJobsResponse | null | undefined, protos.google.dataflow.v1beta3.IJob>): void;

listJobs(request, callback)

listJobs(request: protos.google.dataflow.v1beta3.IListJobsRequest, callback: PaginationCallback<protos.google.dataflow.v1beta3.IListJobsRequest, protos.google.dataflow.v1beta3.IListJobsResponse | null | undefined, protos.google.dataflow.v1beta3.IJob>): void;

listJobsAsync(request, options)

listJobsAsync(request?: protos.google.dataflow.v1beta3.IListJobsRequest, options?: CallOptions): AsyncIterable<protos.google.dataflow.v1beta3.IJob>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The kind of filter to use.
   */
  // const filter = {}
  /**
   *  The project which owns the jobs.
   */
  // const projectId = 'abc123'
  /**
   *  If there are many jobs, limit response to at most this many.
   *  The actual number of jobs returned will be the lesser of max_responses
   *  and an unspecified server-defined limit.
   */
  // const pageSize = 1234
  /**
   *  Set this to the 'next_page_token' field of a previous response
   *  to request additional results in a long list.
   */
  // const pageToken = 'abc123'
  /**
   *  The regional endpoint
   *  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
   *  contains this job.
   */
  // const location = 'abc123'

  // Imports the Dataflow library
  const {JobsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;

  // Instantiates a client
  const dataflowClient = new JobsV1Beta3Client();

  async function callListJobs() {
    // Construct request
    const request = {};

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

  callListJobs();

listJobsStream(request, options)

listJobsStream(request?: protos.google.dataflow.v1beta3.IListJobsRequest, options?: CallOptions): Transform;

snapshotJob(request, options)

snapshotJob(request?: protos.google.dataflow.v1beta3.ISnapshotJobRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.ISnapshot,
        protos.google.dataflow.v1beta3.ISnapshotJobRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The project which owns the job to be snapshotted.
   */
  // const projectId = 'abc123'
  /**
   *  The job to be snapshotted.
   */
  // const jobId = 'abc123'
  /**
   *  TTL for the snapshot.
   */
  // const ttl = {}
  /**
   *  The location that contains this job.
   */
  // const location = 'abc123'
  /**
   *  If true, perform snapshots for sources which support this.
   */
  // const snapshotSources = true
  /**
   *  User specified description of the snapshot. Maybe empty.
   */
  // const description = 'abc123'

  // Imports the Dataflow library
  const {JobsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;

  // Instantiates a client
  const dataflowClient = new JobsV1Beta3Client();

  async function callSnapshotJob() {
    // Construct request
    const request = {};

    // Run request
    const response = await dataflowClient.snapshotJob(request);
    console.log(response);
  }

  callSnapshotJob();

snapshotJob(request, options, callback)

snapshotJob(request: protos.google.dataflow.v1beta3.ISnapshotJobRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.ISnapshot, protos.google.dataflow.v1beta3.ISnapshotJobRequest | null | undefined, {} | null | undefined>): void;

snapshotJob(request, callback)

snapshotJob(request: protos.google.dataflow.v1beta3.ISnapshotJobRequest, callback: Callback<protos.google.dataflow.v1beta3.ISnapshot, protos.google.dataflow.v1beta3.ISnapshotJobRequest | null | undefined, {} | null | undefined>): void;

updateJob(request, options)

updateJob(request?: protos.google.dataflow.v1beta3.IUpdateJobRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IJob,
        protos.google.dataflow.v1beta3.IUpdateJobRequest | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The ID of the Cloud Platform project that the job belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  The job ID.
   */
  // const jobId = 'abc123'
  /**
   *  The updated job.
   *  Only the job state is updatable; other fields will be ignored.
   */
  // const job = {}
  /**
   *  The regional endpoint
   *  (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
   *  contains this job.
   */
  // const location = 'abc123'

  // Imports the Dataflow library
  const {JobsV1Beta3Client} = require('@google-cloud/dataflow').v1beta3;

  // Instantiates a client
  const dataflowClient = new JobsV1Beta3Client();

  async function callUpdateJob() {
    // Construct request
    const request = {};

    // Run request
    const response = await dataflowClient.updateJob(request);
    console.log(response);
  }

  callUpdateJob();

updateJob(request, options, callback)

updateJob(request: protos.google.dataflow.v1beta3.IUpdateJobRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.IUpdateJobRequest | null | undefined, {} | null | undefined>): void;

updateJob(request, callback)

updateJob(request: protos.google.dataflow.v1beta3.IUpdateJobRequest, callback: Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.IUpdateJobRequest | null | undefined, {} | null | undefined>): void;