Google Cloud Dataflow V1beta3 Client - Class Snapshot (0.5.1)

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class Snapshot.

Represents a snapshot of a job.

Generated from protobuf message google.dataflow.v1beta3.Snapshot

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ id string

The unique ID of this snapshot.

↳ project_id string

The project this snapshot belongs to.

↳ source_job_id string

The job this snapshot was created from.

↳ creation_time Google\Protobuf\Timestamp

The time this snapshot was created.

↳ ttl Google\Protobuf\Duration

The time after which this snapshot will be automatically deleted.

↳ state int

State of the snapshot.

↳ pubsub_metadata array<Google\Cloud\Dataflow\V1beta3\PubsubSnapshotMetadata>

Pub/Sub snapshot metadata.

↳ description string

User specified description of the snapshot. Maybe empty.

↳ disk_size_bytes int|string

The disk byte size of the snapshot. Only available for snapshots in READY state.

↳ region string

Cloud region where this snapshot lives in, e.g., "us-central1".

getId

The unique ID of this snapshot.

Returns
TypeDescription
string

setId

The unique ID of this snapshot.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProjectId

The project this snapshot belongs to.

Returns
TypeDescription
string

setProjectId

The project this snapshot belongs to.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSourceJobId

The job this snapshot was created from.

Returns
TypeDescription
string

setSourceJobId

The job this snapshot was created from.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreationTime

The time this snapshot was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreationTime

clearCreationTime

setCreationTime

The time this snapshot was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getTtl

The time after which this snapshot will be automatically deleted.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasTtl

clearTtl

setTtl

The time after which this snapshot will be automatically deleted.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getState

State of the snapshot.

Returns
TypeDescription
int

setState

State of the snapshot.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPubsubMetadata

Pub/Sub snapshot metadata.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPubsubMetadata

Pub/Sub snapshot metadata.

Parameter
NameDescription
var array<Google\Cloud\Dataflow\V1beta3\PubsubSnapshotMetadata>
Returns
TypeDescription
$this

getDescription

User specified description of the snapshot. Maybe empty.

Returns
TypeDescription
string

setDescription

User specified description of the snapshot. Maybe empty.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDiskSizeBytes

The disk byte size of the snapshot. Only available for snapshots in READY state.

Returns
TypeDescription
int|string

setDiskSizeBytes

The disk byte size of the snapshot. Only available for snapshots in READY state.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getRegion

Cloud region where this snapshot lives in, e.g., "us-central1".

Returns
TypeDescription
string

setRegion

Cloud region where this snapshot lives in, e.g., "us-central1".

Parameter
NameDescription
var string
Returns
TypeDescription
$this