Represents a BackfillJob.
Package
@google-cloud/datastreamConstructors
(constructor)(properties)
constructor(properties?: google.cloud.datastream.v1.IBackfillJob);Constructs a new BackfillJob.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackfillJob
Properties to set |
Properties
errors
public errors: google.cloud.datastream.v1.IError[];BackfillJob errors.
lastEndTime
public lastEndTime?: (google.protobuf.ITimestamp|null);BackfillJob lastEndTime.
lastStartTime
public lastStartTime?: (google.protobuf.ITimestamp|null);BackfillJob lastStartTime.
state
public state: (google.cloud.datastream.v1.BackfillJob.State|keyof typeof google.cloud.datastream.v1.BackfillJob.State);BackfillJob state.
trigger
public trigger: (google.cloud.datastream.v1.BackfillJob.Trigger|keyof typeof google.cloud.datastream.v1.BackfillJob.Trigger);BackfillJob trigger.
Methods
create(properties)
public static create(properties?: google.cloud.datastream.v1.IBackfillJob): google.cloud.datastream.v1.BackfillJob;Creates a new BackfillJob instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackfillJob
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BackfillJob |
BackfillJob instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datastream.v1.BackfillJob;Decodes a BackfillJob 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 |
BackfillJob |
BackfillJob |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datastream.v1.BackfillJob;Decodes a BackfillJob message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BackfillJob |
BackfillJob |
encode(message, writer)
public static encode(message: google.cloud.datastream.v1.IBackfillJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackfillJob message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackfillJob
BackfillJob 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.v1.IBackfillJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackfillJob message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackfillJob
BackfillJob 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.v1.BackfillJob;Creates a BackfillJob 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 |
BackfillJob |
BackfillJob |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BackfillJob
| 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 BackfillJob to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datastream.v1.BackfillJob, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BackfillJob message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BackfillJob
BackfillJob |
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 BackfillJob message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|