Google Cloud Dataflow V1beta3 Client - Class Snapshot (0.6.3)

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
Name Description
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
Type Description
string

setId

The unique ID of this snapshot.

Parameter
Name Description
var string
Returns
Type Description
$this

getProjectId

The project this snapshot belongs to.

Returns
Type Description
string

setProjectId

The project this snapshot belongs to.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceJobId

The job this snapshot was created from.

Returns
Type Description
string

setSourceJobId

The job this snapshot was created from.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreationTime

The time this snapshot was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreationTime

clearCreationTime

setCreationTime

The time this snapshot was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getTtl

The time after which this snapshot will be automatically deleted.

Returns
Type Description
Google\Protobuf\Duration|null

hasTtl

clearTtl

setTtl

The time after which this snapshot will be automatically deleted.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getState

State of the snapshot.

Returns
Type Description
int

setState

State of the snapshot.

Parameter
Name Description
var int
Returns
Type Description
$this

getPubsubMetadata

Pub/Sub snapshot metadata.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPubsubMetadata

Pub/Sub snapshot metadata.

Parameter
Name Description
var array<Google\Cloud\Dataflow\V1beta3\PubsubSnapshotMetadata>
Returns
Type Description
$this

getDescription

User specified description of the snapshot. Maybe empty.

Returns
Type Description
string

setDescription

User specified description of the snapshot. Maybe empty.

Parameter
Name Description
var string
Returns
Type Description
$this

getDiskSizeBytes

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

Returns
Type Description
int|string

setDiskSizeBytes

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getRegion

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

Returns
Type Description
string

setRegion

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

Parameter
Name Description
var string
Returns
Type Description
$this