Class v1beta3.TemplatesServiceClient

Provides a method to create Cloud Dataflow jobs from templates. v1beta3

Package

@google-cloud/dataflow!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of TemplatesServiceClient.

Parameter
TypeNameDescription
ClientOptionsopts

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
TypeDescription
string

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

innerApiCalls

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

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

scopes

static get scopes(): string[];

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

Property Value
TypeDescription
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

templatesServiceStub

templatesServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
TypeDescription
Promise<{ [name: string]: Function; }>

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
TypeDescription
(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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

createJobFromTemplate(request, options)

createJobFromTemplate(request?: protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IJob,
        protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequest | undefined,
        {} | undefined
    ]>;
Parameters
TypeNameDescription
protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[ protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequest | undefined, {} | undefined ]>

createJobFromTemplate(request, options, callback)

createJobFromTemplate(request: protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequestrequest
CallOptionsoptions
Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

createJobFromTemplate(request, callback)

createJobFromTemplate(request: protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequest, callback: Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequestrequest
Callback<protos.google.dataflow.v1beta3.IJob, protos.google.dataflow.v1beta3.ICreateJobFromTemplateRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
TypeNameDescription
Callback<string, undefined, undefined>callback
Returns
TypeDescription
void

getTemplate(request, options)

getTemplate(request?: protos.google.dataflow.v1beta3.IGetTemplateRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.IGetTemplateResponse,
        protos.google.dataflow.v1beta3.IGetTemplateRequest | undefined,
        {} | undefined
    ]>;
Parameters
TypeNameDescription
protos.google.dataflow.v1beta3.IGetTemplateRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[ protos.google.dataflow.v1beta3.IGetTemplateResponse, protos.google.dataflow.v1beta3.IGetTemplateRequest | undefined, {} | undefined ]>

getTemplate(request, options, callback)

getTemplate(request: protos.google.dataflow.v1beta3.IGetTemplateRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.IGetTemplateResponse, protos.google.dataflow.v1beta3.IGetTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.dataflow.v1beta3.IGetTemplateRequestrequest
CallOptionsoptions
Callback<protos.google.dataflow.v1beta3.IGetTemplateResponse, protos.google.dataflow.v1beta3.IGetTemplateRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

getTemplate(request, callback)

getTemplate(request: protos.google.dataflow.v1beta3.IGetTemplateRequest, callback: Callback<protos.google.dataflow.v1beta3.IGetTemplateResponse, protos.google.dataflow.v1beta3.IGetTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.dataflow.v1beta3.IGetTemplateRequestrequest
Callback<protos.google.dataflow.v1beta3.IGetTemplateResponse, protos.google.dataflow.v1beta3.IGetTemplateRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

launchTemplate(request, options)

launchTemplate(request?: protos.google.dataflow.v1beta3.ILaunchTemplateRequest, options?: CallOptions): Promise<[
        protos.google.dataflow.v1beta3.ILaunchTemplateResponse,
        protos.google.dataflow.v1beta3.ILaunchTemplateRequest | undefined,
        {} | undefined
    ]>;
Parameters
TypeNameDescription
protos.google.dataflow.v1beta3.ILaunchTemplateRequestrequest
CallOptionsoptions
Returns
TypeDescription
Promise<[ protos.google.dataflow.v1beta3.ILaunchTemplateResponse, protos.google.dataflow.v1beta3.ILaunchTemplateRequest | undefined, {} | undefined ]>

launchTemplate(request, options, callback)

launchTemplate(request: protos.google.dataflow.v1beta3.ILaunchTemplateRequest, options: CallOptions, callback: Callback<protos.google.dataflow.v1beta3.ILaunchTemplateResponse, protos.google.dataflow.v1beta3.ILaunchTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.dataflow.v1beta3.ILaunchTemplateRequestrequest
CallOptionsoptions
Callback<protos.google.dataflow.v1beta3.ILaunchTemplateResponse, protos.google.dataflow.v1beta3.ILaunchTemplateRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void

launchTemplate(request, callback)

launchTemplate(request: protos.google.dataflow.v1beta3.ILaunchTemplateRequest, callback: Callback<protos.google.dataflow.v1beta3.ILaunchTemplateResponse, protos.google.dataflow.v1beta3.ILaunchTemplateRequest | null | undefined, {} | null | undefined>): void;
Parameters
TypeNameDescription
protos.google.dataflow.v1beta3.ILaunchTemplateRequestrequest
Callback<protos.google.dataflow.v1beta3.ILaunchTemplateResponse, protos.google.dataflow.v1beta3.ILaunchTemplateRequest | null | undefined, {} | null | undefined>callback
Returns
TypeDescription
void