Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::Snapshot.
Represents a snapshot of a job.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#creation_time
def creation_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time this snapshot was created.
#creation_time=
def creation_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time this snapshot was created.
Returns
- (::Google::Protobuf::Timestamp) — The time this snapshot was created.
#description
def description() -> ::String
Returns
- (::String) — User specified description of the snapshot. Maybe empty.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — User specified description of the snapshot. Maybe empty.
Returns
- (::String) — User specified description of the snapshot. Maybe empty.
#disk_size_bytes
def disk_size_bytes() -> ::Integer
Returns
- (::Integer) — The disk byte size of the snapshot. Only available for snapshots in READY state.
#disk_size_bytes=
def disk_size_bytes=(value) -> ::Integer
Parameter
- value (::Integer) — The disk byte size of the snapshot. Only available for snapshots in READY state.
Returns
- (::Integer) — The disk byte size of the snapshot. Only available for snapshots in READY state.
#id
def id() -> ::String
Returns
- (::String) — The unique ID of this snapshot.
#id=
def id=(value) -> ::String
Parameter
- value (::String) — The unique ID of this snapshot.
Returns
- (::String) — The unique ID of this snapshot.
#project_id
def project_id() -> ::String
Returns
- (::String) — The project this snapshot belongs to.
#project_id=
def project_id=(value) -> ::String
Parameter
- value (::String) — The project this snapshot belongs to.
Returns
- (::String) — The project this snapshot belongs to.
#pubsub_metadata
def pubsub_metadata() -> ::Array<::Google::Cloud::Dataflow::V1beta3::PubsubSnapshotMetadata>
Returns
- (::Array<::Google::Cloud::Dataflow::V1beta3::PubsubSnapshotMetadata>) — Pub/Sub snapshot metadata.
#pubsub_metadata=
def pubsub_metadata=(value) -> ::Array<::Google::Cloud::Dataflow::V1beta3::PubsubSnapshotMetadata>
Parameter
- value (::Array<::Google::Cloud::Dataflow::V1beta3::PubsubSnapshotMetadata>) — Pub/Sub snapshot metadata.
Returns
- (::Array<::Google::Cloud::Dataflow::V1beta3::PubsubSnapshotMetadata>) — Pub/Sub snapshot metadata.
#region
def region() -> ::String
Returns
- (::String) — Cloud region where this snapshot lives in, e.g., "us-central1".
#region=
def region=(value) -> ::String
Parameter
- value (::String) — Cloud region where this snapshot lives in, e.g., "us-central1".
Returns
- (::String) — Cloud region where this snapshot lives in, e.g., "us-central1".
#source_job_id
def source_job_id() -> ::String
Returns
- (::String) — The job this snapshot was created from.
#source_job_id=
def source_job_id=(value) -> ::String
Parameter
- value (::String) — The job this snapshot was created from.
Returns
- (::String) — The job this snapshot was created from.
#state
def state() -> ::Google::Cloud::Dataflow::V1beta3::SnapshotState
Returns
- (::Google::Cloud::Dataflow::V1beta3::SnapshotState) — State of the snapshot.
#state=
def state=(value) -> ::Google::Cloud::Dataflow::V1beta3::SnapshotState
Parameter
- value (::Google::Cloud::Dataflow::V1beta3::SnapshotState) — State of the snapshot.
Returns
- (::Google::Cloud::Dataflow::V1beta3::SnapshotState) — State of the snapshot.
#ttl
def ttl() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — The time after which this snapshot will be automatically deleted.
#ttl=
def ttl=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — The time after which this snapshot will be automatically deleted.
Returns
- (::Google::Protobuf::Duration) — The time after which this snapshot will be automatically deleted.