Represents a Stream.
Package
@google-cloud/datastreamConstructors
(constructor)(properties)
constructor(properties?: google.cloud.datastream.v1alpha1.IStream);Constructs a new Stream.
| Parameter | |
|---|---|
| Name | Description |
properties |
IStream
Properties to set |
Properties
backfillAll
public backfillAll?: (google.cloud.datastream.v1alpha1.Stream.IBackfillAllStrategy|null);Stream backfillAll.
backfillNone
public backfillNone?: (google.cloud.datastream.v1alpha1.Stream.IBackfillNoneStrategy|null);Stream backfillNone.
backfillStrategy
public backfillStrategy?: ("backfillAll"|"backfillNone");Stream backfillStrategy.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Stream createTime.
destinationConfig
public destinationConfig?: (google.cloud.datastream.v1alpha1.IDestinationConfig|null);Stream destinationConfig.
displayName
public displayName: string;Stream displayName.
errors
public errors: google.cloud.datastream.v1alpha1.IError[];Stream errors.
labels
public labels: { [k: string]: string };Stream labels.
name
public name: string;Stream name.
sourceConfig
public sourceConfig?: (google.cloud.datastream.v1alpha1.ISourceConfig|null);Stream sourceConfig.
state
public state: (google.cloud.datastream.v1alpha1.Stream.State|keyof typeof google.cloud.datastream.v1alpha1.Stream.State);Stream state.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Stream updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.datastream.v1alpha1.IStream): google.cloud.datastream.v1alpha1.Stream;Creates a new Stream instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IStream
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Stream | Stream instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datastream.v1alpha1.Stream;Decodes a Stream message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Stream | Stream |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datastream.v1alpha1.Stream;Decodes a Stream message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Stream | Stream |
encode(message, writer)
public static encode(message: google.cloud.datastream.v1alpha1.IStream, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Stream message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IStream
Stream message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.datastream.v1alpha1.IStream, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Stream message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IStream
Stream message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.datastream.v1alpha1.Stream;Creates a Stream message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Stream | Stream |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Stream
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Stream to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datastream.v1alpha1.Stream, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Stream message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Stream
Stream |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Stream message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|