Represents a SnapshotJobRequest.
Package
@google-cloud/dataflowConstructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.ISnapshotJobRequest);Constructs a new SnapshotJobRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISnapshotJobRequest
Properties to set |
Properties
description
public description: string;SnapshotJobRequest description.
jobId
public jobId: string;SnapshotJobRequest jobId.
location
public location: string;SnapshotJobRequest location.
projectId
public projectId: string;SnapshotJobRequest projectId.
snapshotSources
public snapshotSources: boolean;SnapshotJobRequest snapshotSources.
ttl
public ttl?: (google.protobuf.IDuration|null);SnapshotJobRequest ttl.
Methods
create(properties)
public static create(properties?: google.dataflow.v1beta3.ISnapshotJobRequest): google.dataflow.v1beta3.SnapshotJobRequest;Creates a new SnapshotJobRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISnapshotJobRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.dataflow.v1beta3.SnapshotJobRequest | SnapshotJobRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.SnapshotJobRequest;Decodes a SnapshotJobRequest message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.dataflow.v1beta3.SnapshotJobRequest | SnapshotJobRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.SnapshotJobRequest;Decodes a SnapshotJobRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.dataflow.v1beta3.SnapshotJobRequest | SnapshotJobRequest |
encode(message, writer)
public static encode(message: google.dataflow.v1beta3.ISnapshotJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SnapshotJobRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISnapshotJobRequest
SnapshotJobRequest 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.dataflow.v1beta3.ISnapshotJobRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SnapshotJobRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISnapshotJobRequest
SnapshotJobRequest 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.dataflow.v1beta3.SnapshotJobRequest;Creates a SnapshotJobRequest 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 |
google.dataflow.v1beta3.SnapshotJobRequest | SnapshotJobRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for SnapshotJobRequest
| 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 SnapshotJobRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.dataflow.v1beta3.SnapshotJobRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a SnapshotJobRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.dataflow.v1beta3.SnapshotJobRequest
SnapshotJobRequest |
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 SnapshotJobRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|