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

Represents a ListJobMessagesRequest.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

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

Constructs a new ListJobMessagesRequest.

Parameter
NameDescription
properties IListJobMessagesRequest

Properties to set

Properties

endTime

public endTime?: (google.protobuf.ITimestamp|null);

ListJobMessagesRequest endTime.

jobId

public jobId: string;

ListJobMessagesRequest jobId.

location

public location: string;

ListJobMessagesRequest location.

minimumImportance

public minimumImportance: (google.dataflow.v1beta3.JobMessageImportance|keyof typeof google.dataflow.v1beta3.JobMessageImportance);

ListJobMessagesRequest minimumImportance.

pageSize

public pageSize: number;

ListJobMessagesRequest pageSize.

pageToken

public pageToken: string;

ListJobMessagesRequest pageToken.

projectId

public projectId: string;

ListJobMessagesRequest projectId.

startTime

public startTime?: (google.protobuf.ITimestamp|null);

ListJobMessagesRequest startTime.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IListJobMessagesRequest): google.dataflow.v1beta3.ListJobMessagesRequest;

Creates a new ListJobMessagesRequest instance using the specified properties.

Parameter
NameDescription
properties IListJobMessagesRequest

Properties to set

Returns
TypeDescription
ListJobMessagesRequest

ListJobMessagesRequest instance

decode(reader, length)

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

Decodes a ListJobMessagesRequest 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
ListJobMessagesRequest

ListJobMessagesRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ListJobMessagesRequest

ListJobMessagesRequest

encode(message, writer)

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

Encodes the specified ListJobMessagesRequest message. Does not implicitly messages.

Parameters
NameDescription
message IListJobMessagesRequest

ListJobMessagesRequest 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.IListJobMessagesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IListJobMessagesRequest

ListJobMessagesRequest 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.ListJobMessagesRequest;

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

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

Plain object

Returns
TypeDescription
ListJobMessagesRequest

ListJobMessagesRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ListJobMessagesRequest

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 ListJobMessagesRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message ListJobMessagesRequest

ListJobMessagesRequest

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 ListJobMessagesRequest 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