Class Snapshot.Builder (0.57.0) 

public static final class Snapshot.Builder extends GeneratedMessageV3.Builder<Snapshot.Builder> implements SnapshotOrBuilder

Represents a snapshot of a job.

Protobuf type google.dataflow.v1beta3.Snapshot

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Snapshot.Builder

Implements

SnapshotOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllPubsubMetadata(Iterable<? extends PubsubSnapshotMetadata> values)

public Snapshot.Builder addAllPubsubMetadata(Iterable<? extends PubsubSnapshotMetadata> values)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameter
Name Description
values Iterable<? extends com.google.dataflow.v1beta3.PubsubSnapshotMetadata>
Returns
Type Description
Snapshot.Builder

addPubsubMetadata(PubsubSnapshotMetadata value)

public Snapshot.Builder addPubsubMetadata(PubsubSnapshotMetadata value)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameter
Name Description
value PubsubSnapshotMetadata
Returns
Type Description
Snapshot.Builder

addPubsubMetadata(PubsubSnapshotMetadata.Builder builderForValue)

public Snapshot.Builder addPubsubMetadata(PubsubSnapshotMetadata.Builder builderForValue)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameter
Name Description
builderForValue PubsubSnapshotMetadata.Builder
Returns
Type Description
Snapshot.Builder

addPubsubMetadata(int index, PubsubSnapshotMetadata value)

public Snapshot.Builder addPubsubMetadata(int index, PubsubSnapshotMetadata value)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameters
Name Description
index int
value PubsubSnapshotMetadata
Returns
Type Description
Snapshot.Builder

addPubsubMetadata(int index, PubsubSnapshotMetadata.Builder builderForValue)

public Snapshot.Builder addPubsubMetadata(int index, PubsubSnapshotMetadata.Builder builderForValue)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameters
Name Description
index int
builderForValue PubsubSnapshotMetadata.Builder
Returns
Type Description
Snapshot.Builder

addPubsubMetadataBuilder()

public PubsubSnapshotMetadata.Builder addPubsubMetadataBuilder()

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Returns
Type Description
PubsubSnapshotMetadata.Builder

addPubsubMetadataBuilder(int index)

public PubsubSnapshotMetadata.Builder addPubsubMetadataBuilder(int index)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameter
Name Description
index int
Returns
Type Description
PubsubSnapshotMetadata.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Snapshot.Builder
Overrides

build()

public Snapshot build()
Returns
Type Description
Snapshot

buildPartial()

public Snapshot buildPartial()
Returns
Type Description
Snapshot

clear()

public Snapshot.Builder clear()
Returns
Type Description
Snapshot.Builder
Overrides

clearCreationTime()

public Snapshot.Builder clearCreationTime()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
Type Description
Snapshot.Builder

clearDescription()

public Snapshot.Builder clearDescription()

User specified description of the snapshot. Maybe empty.

string description = 8;

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearDiskSizeBytes()

public Snapshot.Builder clearDiskSizeBytes()

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

int64 disk_size_bytes = 9;

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Snapshot.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Snapshot.Builder
Overrides

clearId()

public Snapshot.Builder clearId()

The unique ID of this snapshot.

string id = 1;

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Snapshot.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Snapshot.Builder
Overrides

clearProjectId()

public Snapshot.Builder clearProjectId()

The project this snapshot belongs to.

string project_id = 2;

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearPubsubMetadata()

public Snapshot.Builder clearPubsubMetadata()

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Returns
Type Description
Snapshot.Builder

clearRegion()

public Snapshot.Builder clearRegion()

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

string region = 10;

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearSourceJobId()

public Snapshot.Builder clearSourceJobId()

The job this snapshot was created from.

string source_job_id = 3;

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearState()

public Snapshot.Builder clearState()

State of the snapshot.

.google.dataflow.v1beta3.SnapshotState state = 6;

Returns
Type Description
Snapshot.Builder

This builder for chaining.

clearTtl()

public Snapshot.Builder clearTtl()

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Returns
Type Description
Snapshot.Builder

clone()

public Snapshot.Builder clone()
Returns
Type Description
Snapshot.Builder
Overrides

getCreationTime()

public Timestamp getCreationTime()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
Type Description
Timestamp

The creationTime.

getCreationTimeBuilder()

public Timestamp.Builder getCreationTimeBuilder()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
Type Description
Builder

getCreationTimeOrBuilder()

public TimestampOrBuilder getCreationTimeOrBuilder()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Snapshot getDefaultInstanceForType()
Returns
Type Description
Snapshot

getDescription()

public String getDescription()

User specified description of the snapshot. Maybe empty.

string description = 8;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User specified description of the snapshot. Maybe empty.

string description = 8;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDiskSizeBytes()

public long getDiskSizeBytes()

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

int64 disk_size_bytes = 9;

Returns
Type Description
long

The diskSizeBytes.

getId()

public String getId()

The unique ID of this snapshot.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

The unique ID of this snapshot.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getProjectId()

public String getProjectId()

The project this snapshot belongs to.

string project_id = 2;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

The project this snapshot belongs to.

string project_id = 2;

Returns
Type Description
ByteString

The bytes for projectId.

getPubsubMetadata(int index)

public PubsubSnapshotMetadata getPubsubMetadata(int index)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameter
Name Description
index int
Returns
Type Description
PubsubSnapshotMetadata

getPubsubMetadataBuilder(int index)

public PubsubSnapshotMetadata.Builder getPubsubMetadataBuilder(int index)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameter
Name Description
index int
Returns
Type Description
PubsubSnapshotMetadata.Builder

getPubsubMetadataBuilderList()

public List<PubsubSnapshotMetadata.Builder> getPubsubMetadataBuilderList()

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Returns
Type Description
List<Builder>

getPubsubMetadataCount()

public int getPubsubMetadataCount()

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Returns
Type Description
int

getPubsubMetadataList()

public List<PubsubSnapshotMetadata> getPubsubMetadataList()

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Returns
Type Description
List<PubsubSnapshotMetadata>

getPubsubMetadataOrBuilder(int index)

public PubsubSnapshotMetadataOrBuilder getPubsubMetadataOrBuilder(int index)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameter
Name Description
index int
Returns
Type Description
PubsubSnapshotMetadataOrBuilder

getPubsubMetadataOrBuilderList()

public List<? extends PubsubSnapshotMetadataOrBuilder> getPubsubMetadataOrBuilderList()

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Returns
Type Description
List<? extends com.google.dataflow.v1beta3.PubsubSnapshotMetadataOrBuilder>

getRegion()

public String getRegion()

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

string region = 10;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

string region = 10;

Returns
Type Description
ByteString

The bytes for region.

getSourceJobId()

public String getSourceJobId()

The job this snapshot was created from.

string source_job_id = 3;

Returns
Type Description
String

The sourceJobId.

getSourceJobIdBytes()

public ByteString getSourceJobIdBytes()

The job this snapshot was created from.

string source_job_id = 3;

Returns
Type Description
ByteString

The bytes for sourceJobId.

getState()

public SnapshotState getState()

State of the snapshot.

.google.dataflow.v1beta3.SnapshotState state = 6;

Returns
Type Description
SnapshotState

The state.

getStateValue()

public int getStateValue()

State of the snapshot.

.google.dataflow.v1beta3.SnapshotState state = 6;

Returns
Type Description
int

The enum numeric value on the wire for state.

getTtl()

public Duration getTtl()

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Returns
Type Description
Duration

The ttl.

getTtlBuilder()

public Duration.Builder getTtlBuilder()

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Returns
Type Description
Builder

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Returns
Type Description
DurationOrBuilder

hasCreationTime()

public boolean hasCreationTime()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
Type Description
boolean

Whether the creationTime field is set.

hasTtl()

public boolean hasTtl()

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Returns
Type Description
boolean

Whether the ttl field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreationTime(Timestamp value)

public Snapshot.Builder mergeCreationTime(Timestamp value)

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
Snapshot.Builder

mergeFrom(Snapshot other)

public Snapshot.Builder mergeFrom(Snapshot other)
Parameter
Name Description
other Snapshot
Returns
Type Description
Snapshot.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Snapshot.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Snapshot.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Snapshot.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Snapshot.Builder
Overrides

mergeTtl(Duration value)

public Snapshot.Builder mergeTtl(Duration value)

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Parameter
Name Description
value Duration
Returns
Type Description
Snapshot.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Snapshot.Builder
Overrides

removePubsubMetadata(int index)

public Snapshot.Builder removePubsubMetadata(int index)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameter
Name Description
index int
Returns
Type Description
Snapshot.Builder

setCreationTime(Timestamp value)

public Snapshot.Builder setCreationTime(Timestamp value)

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
Snapshot.Builder

setCreationTime(Timestamp.Builder builderForValue)

public Snapshot.Builder setCreationTime(Timestamp.Builder builderForValue)

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Snapshot.Builder

setDescription(String value)

public Snapshot.Builder setDescription(String value)

User specified description of the snapshot. Maybe empty.

string description = 8;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Snapshot.Builder setDescriptionBytes(ByteString value)

User specified description of the snapshot. Maybe empty.

string description = 8;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setDiskSizeBytes(long value)

public Snapshot.Builder setDiskSizeBytes(long value)

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

int64 disk_size_bytes = 9;

Parameter
Name Description
value long

The diskSizeBytes to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Snapshot.Builder
Overrides

setId(String value)

public Snapshot.Builder setId(String value)

The unique ID of this snapshot.

string id = 1;

Parameter
Name Description
value String

The id to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Snapshot.Builder setIdBytes(ByteString value)

The unique ID of this snapshot.

string id = 1;

Parameter
Name Description
value ByteString

The bytes for id to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setProjectId(String value)

public Snapshot.Builder setProjectId(String value)

The project this snapshot belongs to.

string project_id = 2;

Parameter
Name Description
value String

The projectId to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public Snapshot.Builder setProjectIdBytes(ByteString value)

The project this snapshot belongs to.

string project_id = 2;

Parameter
Name Description
value ByteString

The bytes for projectId to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setPubsubMetadata(int index, PubsubSnapshotMetadata value)

public Snapshot.Builder setPubsubMetadata(int index, PubsubSnapshotMetadata value)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameters
Name Description
index int
value PubsubSnapshotMetadata
Returns
Type Description
Snapshot.Builder

setPubsubMetadata(int index, PubsubSnapshotMetadata.Builder builderForValue)

public Snapshot.Builder setPubsubMetadata(int index, PubsubSnapshotMetadata.Builder builderForValue)

Pub/Sub snapshot metadata.

repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;

Parameters
Name Description
index int
builderForValue PubsubSnapshotMetadata.Builder
Returns
Type Description
Snapshot.Builder

setRegion(String value)

public Snapshot.Builder setRegion(String value)

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

string region = 10;

Parameter
Name Description
value String

The region to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public Snapshot.Builder setRegionBytes(ByteString value)

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

string region = 10;

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Snapshot.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Snapshot.Builder
Overrides

setSourceJobId(String value)

public Snapshot.Builder setSourceJobId(String value)

The job this snapshot was created from.

string source_job_id = 3;

Parameter
Name Description
value String

The sourceJobId to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setSourceJobIdBytes(ByteString value)

public Snapshot.Builder setSourceJobIdBytes(ByteString value)

The job this snapshot was created from.

string source_job_id = 3;

Parameter
Name Description
value ByteString

The bytes for sourceJobId to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setState(SnapshotState value)

public Snapshot.Builder setState(SnapshotState value)

State of the snapshot.

.google.dataflow.v1beta3.SnapshotState state = 6;

Parameter
Name Description
value SnapshotState

The state to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setStateValue(int value)

public Snapshot.Builder setStateValue(int value)

State of the snapshot.

.google.dataflow.v1beta3.SnapshotState state = 6;

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Snapshot.Builder

This builder for chaining.

setTtl(Duration value)

public Snapshot.Builder setTtl(Duration value)

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Parameter
Name Description
value Duration
Returns
Type Description
Snapshot.Builder

setTtl(Duration.Builder builderForValue)

public Snapshot.Builder setTtl(Duration.Builder builderForValue)

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Snapshot.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Snapshot.Builder
Overrides