Class protos.google.dataflow.v1beta3.KeyRangeLocation

Represents a KeyRangeLocation.

Package

@google-cloud/dataflow!

Constructors

(constructor)(properties)

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

Constructs a new KeyRangeLocation.

Parameter
TypeNameDescription
IKeyRangeLocationproperties

Properties to set

Properties

dataDisk

public dataDisk: string;

KeyRangeLocation dataDisk.

Property Value
TypeDescription
string

deliveryEndpoint

public deliveryEndpoint: string;

KeyRangeLocation deliveryEndpoint.

Property Value
TypeDescription
string

deprecatedPersistentDirectory

public deprecatedPersistentDirectory: string;

KeyRangeLocation deprecatedPersistentDirectory.

Property Value
TypeDescription
string

end

public end: string;

KeyRangeLocation end.

Property Value
TypeDescription
string

start

public start: string;

KeyRangeLocation start.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IKeyRangeLocation): google.dataflow.v1beta3.KeyRangeLocation;

Creates a new KeyRangeLocation instance using the specified properties.

Parameter
TypeNameDescription
IKeyRangeLocationproperties

Properties to set

Returns
TypeDescription
google.dataflow.v1beta3.KeyRangeLocation

KeyRangeLocation instance

decode(reader, length)

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

Decodes a KeyRangeLocation message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.dataflow.v1beta3.KeyRangeLocation

KeyRangeLocation

decodeDelimited(reader)

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

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.dataflow.v1beta3.KeyRangeLocation

KeyRangeLocation

encode(message, writer)

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

Encodes the specified KeyRangeLocation message. Does not implicitly messages.

Parameters
TypeNameDescription
IKeyRangeLocationmessage

KeyRangeLocation message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
IKeyRangeLocationmessage

KeyRangeLocation message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

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

Plain object

Returns
TypeDescription
google.dataflow.v1beta3.KeyRangeLocation

KeyRangeLocation

toJSON()

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

Converts this KeyRangeLocation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.dataflow.v1beta3.KeyRangeLocationmessage

KeyRangeLocation

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a KeyRangeLocation message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not