Represents a SnapshotJobRequest.
Package
@google-cloud/dataflow!Constructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.ISnapshotJobRequest);Constructs a new SnapshotJobRequest.
| Type | Name | Description |
|---|---|---|
| ISnapshotJobRequest | properties |
Properties to set |
Properties
description
public description: string;SnapshotJobRequest description.
| Type | Description |
|---|---|
| string |
jobId
public jobId: string;SnapshotJobRequest jobId.
| Type | Description |
|---|---|
| string |
location
public location: string;SnapshotJobRequest location.
| Type | Description |
|---|---|
| string |
projectId
public projectId: string;SnapshotJobRequest projectId.
| Type | Description |
|---|---|
| string |
snapshotSources
public snapshotSources: boolean;SnapshotJobRequest snapshotSources.
| Type | Description |
|---|---|
| boolean |
ttl
public ttl?: (google.protobuf.IDuration|null);SnapshotJobRequest ttl.
| Type | Description |
|---|---|
| (google.protobuf.IDuration|null) |
Methods
create(properties)
public static create(properties?: google.dataflow.v1beta3.ISnapshotJobRequest): google.dataflow.v1beta3.SnapshotJobRequest;Creates a new SnapshotJobRequest instance using the specified properties.
| Type | Name | Description |
|---|---|---|
| ISnapshotJobRequest | properties |
Properties to set |
| 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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| 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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| 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.
| Type | Name | Description |
|---|---|---|
| ISnapshotJobRequest | message |
SnapshotJobRequest message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| ISnapshotJobRequest | message |
SnapshotJobRequest message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.dataflow.v1beta3.SnapshotJobRequest | SnapshotJobRequest |
toJSON()
public toJSON(): { [k: string]: any };Converts this SnapshotJobRequest to JSON.
| 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.
| Type | Name | Description |
|---|---|---|
| google.dataflow.v1beta3.SnapshotJobRequest | message |
SnapshotJobRequest |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a SnapshotJobRequest message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|