Class protos.google.cloud.datastream.v1.StreamObject (2.2.2)

Represents a StreamObject.

Package

@google-cloud/datastream

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datastream.v1.IStreamObject);

Constructs a new StreamObject.

Parameter
NameDescription
properties IStreamObject

Properties to set

Properties

backfillJob

public backfillJob?: (google.cloud.datastream.v1.IBackfillJob|null);

StreamObject backfillJob.

createTime

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

StreamObject createTime.

displayName

public displayName: string;

StreamObject displayName.

errors

public errors: google.cloud.datastream.v1.IError[];

StreamObject errors.

name

public name: string;

StreamObject name.

sourceObject

public sourceObject?: (google.cloud.datastream.v1.ISourceObjectIdentifier|null);

StreamObject sourceObject.

updateTime

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

StreamObject updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.datastream.v1.IStreamObject): google.cloud.datastream.v1.StreamObject;

Creates a new StreamObject instance using the specified properties.

Parameter
NameDescription
properties IStreamObject

Properties to set

Returns
TypeDescription
google.cloud.datastream.v1.StreamObject

StreamObject instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datastream.v1.StreamObject;

Decodes a StreamObject message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.datastream.v1.StreamObject

StreamObject

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datastream.v1.StreamObject;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.datastream.v1.StreamObject

StreamObject

encode(message, writer)

public static encode(message: google.cloud.datastream.v1.IStreamObject, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified StreamObject message. Does not implicitly messages.

Parameters
NameDescription
message IStreamObject

StreamObject 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.cloud.datastream.v1.IStreamObject, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IStreamObject

StreamObject 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.cloud.datastream.v1.StreamObject;

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

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

Plain object

Returns
TypeDescription
google.cloud.datastream.v1.StreamObject

StreamObject

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for StreamObject

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.datastream.v1.StreamObject, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.cloud.datastream.v1.StreamObject

StreamObject

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