Class protos.google.dataflow.v1beta3.GetJobExecutionDetailsRequest (3.0.2)

Represents a GetJobExecutionDetailsRequest.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

constructor(properties?: google.dataflow.v1beta3.IGetJobExecutionDetailsRequest);

Constructs a new GetJobExecutionDetailsRequest.

Parameter
NameDescription
properties IGetJobExecutionDetailsRequest

Properties to set

Properties

jobId

public jobId: string;

GetJobExecutionDetailsRequest jobId.

location

public location: string;

GetJobExecutionDetailsRequest location.

pageSize

public pageSize: number;

GetJobExecutionDetailsRequest pageSize.

pageToken

public pageToken: string;

GetJobExecutionDetailsRequest pageToken.

projectId

public projectId: string;

GetJobExecutionDetailsRequest projectId.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IGetJobExecutionDetailsRequest): google.dataflow.v1beta3.GetJobExecutionDetailsRequest;

Creates a new GetJobExecutionDetailsRequest instance using the specified properties.

Parameter
NameDescription
properties IGetJobExecutionDetailsRequest

Properties to set

Returns
TypeDescription
GetJobExecutionDetailsRequest

GetJobExecutionDetailsRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.GetJobExecutionDetailsRequest;

Decodes a GetJobExecutionDetailsRequest message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
GetJobExecutionDetailsRequest

GetJobExecutionDetailsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.GetJobExecutionDetailsRequest;

Decodes a GetJobExecutionDetailsRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
GetJobExecutionDetailsRequest

GetJobExecutionDetailsRequest

encode(message, writer)

public static encode(message: google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GetJobExecutionDetailsRequest message. Does not implicitly messages.

Parameters
NameDescription
message IGetJobExecutionDetailsRequest

GetJobExecutionDetailsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.dataflow.v1beta3.IGetJobExecutionDetailsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GetJobExecutionDetailsRequest message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IGetJobExecutionDetailsRequest

GetJobExecutionDetailsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.dataflow.v1beta3.GetJobExecutionDetailsRequest;

Creates a GetJobExecutionDetailsRequest message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
GetJobExecutionDetailsRequest

GetJobExecutionDetailsRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for GetJobExecutionDetailsRequest

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this GetJobExecutionDetailsRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.dataflow.v1beta3.GetJobExecutionDetailsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a GetJobExecutionDetailsRequest message. Also converts values to other types if specified.

Parameters
NameDescription
message GetJobExecutionDetailsRequest

GetJobExecutionDetailsRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a GetJobExecutionDetailsRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not