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

Represents a StreamLocation.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

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

Constructs a new StreamLocation.

Parameter
NameDescription
properties IStreamLocation

Properties to set

Properties

customSourceLocation

public customSourceLocation?: (google.dataflow.v1beta3.ICustomSourceLocation|null);

StreamLocation customSourceLocation.

location

public location?: ("streamingStageLocation"|"pubsubLocation"|"sideInputLocation"|"customSourceLocation");

StreamLocation location.

pubsubLocation

public pubsubLocation?: (google.dataflow.v1beta3.IPubsubLocation|null);

StreamLocation pubsubLocation.

sideInputLocation

public sideInputLocation?: (google.dataflow.v1beta3.IStreamingSideInputLocation|null);

StreamLocation sideInputLocation.

streamingStageLocation

public streamingStageLocation?: (google.dataflow.v1beta3.IStreamingStageLocation|null);

StreamLocation streamingStageLocation.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IStreamLocation): google.dataflow.v1beta3.StreamLocation;

Creates a new StreamLocation instance using the specified properties.

Parameter
NameDescription
properties IStreamLocation

Properties to set

Returns
TypeDescription
StreamLocation

StreamLocation instance

decode(reader, length)

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

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

StreamLocation

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
StreamLocation

StreamLocation

encode(message, writer)

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

Encodes the specified StreamLocation message. Does not implicitly messages.

Parameters
NameDescription
message IStreamLocation

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

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

Parameters
NameDescription
message IStreamLocation

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

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

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

Plain object

Returns
TypeDescription
StreamLocation

StreamLocation

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for StreamLocation

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message StreamLocation

StreamLocation

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