Class protos.google.dataflow.v1beta3.GetSnapshotRequest

Represents a GetSnapshotRequest.

Package

@google-cloud/dataflow!

Constructors

(constructor)(properties)

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

Constructs a new GetSnapshotRequest.

Parameter
Type Name Description
IGetSnapshotRequest properties

Properties to set

Properties

location

public location: string;

GetSnapshotRequest location.

Property Value
Type Description
string

projectId

public projectId: string;

GetSnapshotRequest projectId.

Property Value
Type Description
string

snapshotId

public snapshotId: string;

GetSnapshotRequest snapshotId.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IGetSnapshotRequest): google.dataflow.v1beta3.GetSnapshotRequest;

Creates a new GetSnapshotRequest instance using the specified properties.

Parameter
Type Name Description
IGetSnapshotRequest properties

Properties to set
Returns
Type Description
google.dataflow.v1beta3.GetSnapshotRequest

GetSnapshotRequest instance

decode(reader, length)

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

Decodes a GetSnapshotRequest message from the specified reader or buffer.

Parameters
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
number length

Message length if known beforehand
Returns
Type Description
google.dataflow.v1beta3.GetSnapshotRequest

GetSnapshotRequest

decodeDelimited(reader)

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

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

Parameter
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
Returns
Type Description
google.dataflow.v1beta3.GetSnapshotRequest

GetSnapshotRequest

encode(message, writer)

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

Encodes the specified GetSnapshotRequest message. Does not implicitly messages.

Parameters
Type Name Description
IGetSnapshotRequest message

GetSnapshotRequest message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Type Name Description
IGetSnapshotRequest message

GetSnapshotRequest message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
Type Name Description
{ [k: string]: any } object

Plain object
Returns
Type Description
google.dataflow.v1beta3.GetSnapshotRequest

GetSnapshotRequest

toJSON()

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

Converts this GetSnapshotRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Type Name Description
google.dataflow.v1beta3.GetSnapshotRequest message

GetSnapshotRequest
$protobuf.IConversionOptions options

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a GetSnapshotRequest message.

Parameter
Type Name Description
{ [k: string]: any } message

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not