Class v1beta3.SnapshotsV1Beta3Client (1.2.0)

Provides methods to manage snapshots of Google Cloud Dataflow jobs. v1beta3

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of SnapshotsV1Beta3Client.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

snapshotsV1Beta3Stub

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

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

close()

close(): Promise<void>;

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<void>	{Promise} A promise that resolves when the client is closed.

deleteSnapshot(request, options)

deleteSnapshot(request?: protos.google.dataflow.v1beta3.IDeleteSnapshotRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IDeleteSnapshotResponse,
        protos.google.dataflow.v1beta3.IDeleteSnapshotRequest | undefined,
        {} | undefined
    ]>;

Deletes a snapshot.

Parameters

Name	Description
request	`protos.google.dataflow.v1beta3.IDeleteSnapshotRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.dataflow.v1beta3.IDeleteSnapshotResponse, protos.google.dataflow.v1beta3.IDeleteSnapshotRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [DeleteSnapshotResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The ID of the Cloud Platform project that the snapshot belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  The ID of the snapshot.
   */
  // const snapshotId = 'abc123'
  /**
   *  The location that contains this snapshot.
   */
  // const location = 'abc123'

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

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

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

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

  callDeleteSnapshot();

deleteSnapshot(request, options, callback)

deleteSnapshot(request: protos.google.dataflow.v1beta3.IDeleteSnapshotRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.IDeleteSnapshotResponse, protos.google.dataflow.v1beta3.IDeleteSnapshotRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.dataflow.v1beta3.IDeleteSnapshotRequest`
options	`CallOptions`
callback	`Callback<protos.google.dataflow.v1beta3.IDeleteSnapshotResponse, protos.google.dataflow.v1beta3.IDeleteSnapshotRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteSnapshot(request, callback)

deleteSnapshot(request: protos.google.dataflow.v1beta3.IDeleteSnapshotRequest, callback: Callback<protos.google.dataflow.v1beta3.IDeleteSnapshotResponse, protos.google.dataflow.v1beta3.IDeleteSnapshotRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.dataflow.v1beta3.IDeleteSnapshotRequest`
callback	`Callback<protos.google.dataflow.v1beta3.IDeleteSnapshotResponse, protos.google.dataflow.v1beta3.IDeleteSnapshotRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

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

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

getSnapshot(request, options)

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

Gets information about a snapshot.

Parameters

Name	Description
request	`protos.google.dataflow.v1beta3.IGetSnapshotRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.dataflow.v1beta3.ISnapshot, protos.google.dataflow.v1beta3.IGetSnapshotRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Snapshot]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The ID of the Cloud Platform project that the snapshot belongs to.
   */
  // const projectId = 'abc123'
  /**
   *  The ID of the snapshot.
   */
  // const snapshotId = 'abc123'
  /**
   *  The location that contains this snapshot.
   */
  // const location = 'abc123'

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

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

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

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

  callGetSnapshot();

getSnapshot(request, options, callback)

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

Parameters

Name	Description
request	`protos.google.dataflow.v1beta3.IGetSnapshotRequest`
options	`CallOptions`
callback	`Callback<protos.google.dataflow.v1beta3.ISnapshot, protos.google.dataflow.v1beta3.IGetSnapshotRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getSnapshot(request, callback)

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

Parameters

Name	Description
request	`protos.google.dataflow.v1beta3.IGetSnapshotRequest`
callback	`Callback<protos.google.dataflow.v1beta3.ISnapshot, protos.google.dataflow.v1beta3.IGetSnapshotRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

initialize()

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

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<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listSnapshots(request, options)

listSnapshots(request?: protos.google.dataflow.v1beta3.IListSnapshotsRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IListSnapshotsResponse,
        protos.google.dataflow.v1beta3.IListSnapshotsRequest | undefined,
        {} | undefined
    ]>;

Lists snapshots.

Parameters

Name	Description
request	`protos.google.dataflow.v1beta3.IListSnapshotsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.dataflow.v1beta3.IListSnapshotsResponse, protos.google.dataflow.v1beta3.IListSnapshotsRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ListSnapshotsResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The project ID to list snapshots for.
   */
  // const projectId = 'abc123'
  /**
   *  If specified, list snapshots created from this job.
   */
  // const jobId = 'abc123'
  /**
   *  The location to list snapshots in.
   */
  // const location = 'abc123'

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

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

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

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

  callListSnapshots();

listSnapshots(request, options, callback)

listSnapshots(request: protos.google.dataflow.v1beta3.IListSnapshotsRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.IListSnapshotsResponse, protos.google.dataflow.v1beta3.IListSnapshotsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.dataflow.v1beta3.IListSnapshotsRequest`
options	`CallOptions`
callback	`Callback<protos.google.dataflow.v1beta3.IListSnapshotsResponse, protos.google.dataflow.v1beta3.IListSnapshotsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

listSnapshots(request, callback)

listSnapshots(request: protos.google.dataflow.v1beta3.IListSnapshotsRequest, callback: Callback<protos.google.dataflow.v1beta3.IListSnapshotsResponse, protos.google.dataflow.v1beta3.IListSnapshotsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.dataflow.v1beta3.IListSnapshotsRequest`
callback	`Callback<protos.google.dataflow.v1beta3.IListSnapshotsResponse, protos.google.dataflow.v1beta3.IListSnapshotsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void