Constructor
new Snapshot(propertiesopt)
Constructs a new Snapshot.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.dataflow.v1beta3.ISnapshot |
<optional> |
Properties to set |
- Implements:
-
- ISnapshot
Members
creationTime
Snapshot creationTime.
description
Snapshot description.
diskSizeBytes
Snapshot diskSizeBytes.
id
Snapshot id.
projectId
Snapshot projectId.
pubsubMetadata
Snapshot pubsubMetadata.
region
Snapshot region.
sourceJobId
Snapshot sourceJobId.
state
Snapshot state.
ttl
Snapshot ttl.
Methods
toJSON() → {Object.<string, *>}
Converts this Snapshot to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.dataflow.v1beta3.Snapshot}
Creates a new Snapshot instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.dataflow.v1beta3.ISnapshot |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.dataflow.v1beta3.Snapshot |
Snapshot instance |
(static) decode(reader, lengthopt) → {google.dataflow.v1beta3.Snapshot}
Decodes a Snapshot message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.dataflow.v1beta3.Snapshot |
Snapshot |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.dataflow.v1beta3.Snapshot}
Decodes a Snapshot message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.dataflow.v1beta3.Snapshot |
Snapshot |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Snapshot message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.dataflow.v1beta3.ISnapshot |
Snapshot message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Snapshot message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.dataflow.v1beta3.ISnapshot |
Snapshot message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.dataflow.v1beta3.Snapshot}
Creates a Snapshot message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.dataflow.v1beta3.Snapshot |
Snapshot |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Snapshot
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Snapshot message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.dataflow.v1beta3.Snapshot |
Snapshot |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Snapshot message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|