Class v1beta3.SnapshotsV1Beta3Client

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

Package

@google-cloud/dataflow!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of SnapshotsV1Beta3Client.

Parameter
Type Name Description
ClientOptions opts

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

snapshotsV1Beta3Stub

snapshotsV1Beta3Stub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(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
    ]>;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IDeleteSnapshotRequest request
CallOptions options
Returns
Type Description
Promise<[ protos.google.dataflow.v1beta3.IDeleteSnapshotResponse, protos.google.dataflow.v1beta3.IDeleteSnapshotRequest | undefined, {} | undefined ]>

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
Type Name Description
protos.google.dataflow.v1beta3.IDeleteSnapshotRequest request
CallOptions options
Callback<protos.google.dataflow.v1beta3.IDeleteSnapshotResponse, protos.google.dataflow.v1beta3.IDeleteSnapshotRequest | null | undefined, {} | null | undefined> callback
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
Type Name Description
protos.google.dataflow.v1beta3.IDeleteSnapshotRequest request
Callback<protos.google.dataflow.v1beta3.IDeleteSnapshotResponse, protos.google.dataflow.v1beta3.IDeleteSnapshotRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Type Name Description
Callback<string, undefined, undefined> callback
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
    ]>;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IGetSnapshotRequest request
CallOptions options
Returns
Type Description
Promise<[ protos.google.dataflow.v1beta3.ISnapshot, protos.google.dataflow.v1beta3.IGetSnapshotRequest | undefined, {} | undefined ]>

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
Type Name Description
protos.google.dataflow.v1beta3.IGetSnapshotRequest request
CallOptions options
Callback<protos.google.dataflow.v1beta3.ISnapshot, protos.google.dataflow.v1beta3.IGetSnapshotRequest | null | undefined, {} | null | undefined> callback
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
Type Name Description
protos.google.dataflow.v1beta3.IGetSnapshotRequest request
Callback<protos.google.dataflow.v1beta3.ISnapshot, protos.google.dataflow.v1beta3.IGetSnapshotRequest | null | undefined, {} | null | undefined> callback
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
    ]>;
Parameters
Type Name Description
protos.google.dataflow.v1beta3.IListSnapshotsRequest request
CallOptions options
Returns
Type Description
Promise<[ protos.google.dataflow.v1beta3.IListSnapshotsResponse, protos.google.dataflow.v1beta3.IListSnapshotsRequest | undefined, {} | undefined ]>

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
Type Name Description
protos.google.dataflow.v1beta3.IListSnapshotsRequest request
CallOptions options
Callback<protos.google.dataflow.v1beta3.IListSnapshotsResponse, protos.google.dataflow.v1beta3.IListSnapshotsRequest | null | undefined, {} | null | undefined> callback
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
Type Name Description
protos.google.dataflow.v1beta3.IListSnapshotsRequest request
Callback<protos.google.dataflow.v1beta3.IListSnapshotsResponse, protos.google.dataflow.v1beta3.IListSnapshotsRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void