Class Snapshot.Builder (0.37.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

Implements

SnapshotOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.dataflow.v1beta3.PubsubSnapshotMetadata>
Returns
TypeDescription
Snapshot.Builder

addPubsubMetadata(PubsubSnapshotMetadata value)

public Snapshot.Builder addPubsubMetadata(PubsubSnapshotMetadata value)

Pub/Sub snapshot metadata.

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

Parameter
NameDescription
valuePubsubSnapshotMetadata
Returns
TypeDescription
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
NameDescription
builderForValuePubsubSnapshotMetadata.Builder
Returns
TypeDescription
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
NameDescription
indexint
valuePubsubSnapshotMetadata
Returns
TypeDescription
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
NameDescription
indexint
builderForValuePubsubSnapshotMetadata.Builder
Returns
TypeDescription
Snapshot.Builder

addPubsubMetadataBuilder()

public PubsubSnapshotMetadata.Builder addPubsubMetadataBuilder()

Pub/Sub snapshot metadata.

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

Returns
TypeDescription
PubsubSnapshotMetadata.Builder

addPubsubMetadataBuilder(int index)

public PubsubSnapshotMetadata.Builder addPubsubMetadataBuilder(int index)

Pub/Sub snapshot metadata.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PubsubSnapshotMetadata.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Snapshot.Builder
Overrides

build()

public Snapshot build()
Returns
TypeDescription
Snapshot

buildPartial()

public Snapshot buildPartial()
Returns
TypeDescription
Snapshot

clear()

public Snapshot.Builder clear()
Returns
TypeDescription
Snapshot.Builder
Overrides

clearCreationTime()

public Snapshot.Builder clearCreationTime()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
TypeDescription
Snapshot.Builder

clearDescription()

public Snapshot.Builder clearDescription()

User specified description of the snapshot. Maybe empty.

string description = 8;

Returns
TypeDescription
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
TypeDescription
Snapshot.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Snapshot.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Snapshot.Builder
Overrides

clearId()

public Snapshot.Builder clearId()

The unique ID of this snapshot.

string id = 1;

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Snapshot.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Snapshot.Builder
Overrides

clearProjectId()

public Snapshot.Builder clearProjectId()

The project this snapshot belongs to.

string project_id = 2;

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

clearPubsubMetadata()

public Snapshot.Builder clearPubsubMetadata()

Pub/Sub snapshot metadata.

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

Returns
TypeDescription
Snapshot.Builder

clearRegion()

public Snapshot.Builder clearRegion()

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

string region = 10;

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

clearSourceJobId()

public Snapshot.Builder clearSourceJobId()

The job this snapshot was created from.

string source_job_id = 3;

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

clearState()

public Snapshot.Builder clearState()

State of the snapshot.

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

Returns
TypeDescription
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
TypeDescription
Snapshot.Builder

clone()

public Snapshot.Builder clone()
Returns
TypeDescription
Snapshot.Builder
Overrides

getCreationTime()

public Timestamp getCreationTime()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
TypeDescription
Timestamp

The creationTime.

getCreationTimeBuilder()

public Timestamp.Builder getCreationTimeBuilder()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
TypeDescription
Builder

getCreationTimeOrBuilder()

public TimestampOrBuilder getCreationTimeOrBuilder()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Snapshot getDefaultInstanceForType()
Returns
TypeDescription
Snapshot

getDescription()

public String getDescription()

User specified description of the snapshot. Maybe empty.

string description = 8;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User specified description of the snapshot. Maybe empty.

string description = 8;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
long

The diskSizeBytes.

getId()

public String getId()

The unique ID of this snapshot.

string id = 1;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

The unique ID of this snapshot.

string id = 1;

Returns
TypeDescription
ByteString

The bytes for id.

getProjectId()

public String getProjectId()

The project this snapshot belongs to.

string project_id = 2;

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

The project this snapshot belongs to.

string project_id = 2;

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
PubsubSnapshotMetadata

getPubsubMetadataBuilder(int index)

public PubsubSnapshotMetadata.Builder getPubsubMetadataBuilder(int index)

Pub/Sub snapshot metadata.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PubsubSnapshotMetadata.Builder

getPubsubMetadataBuilderList()

public List<PubsubSnapshotMetadata.Builder> getPubsubMetadataBuilderList()

Pub/Sub snapshot metadata.

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

Returns
TypeDescription
List<Builder>

getPubsubMetadataCount()

public int getPubsubMetadataCount()

Pub/Sub snapshot metadata.

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

Returns
TypeDescription
int

getPubsubMetadataList()

public List<PubsubSnapshotMetadata> getPubsubMetadataList()

Pub/Sub snapshot metadata.

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

Returns
TypeDescription
List<PubsubSnapshotMetadata>

getPubsubMetadataOrBuilder(int index)

public PubsubSnapshotMetadataOrBuilder getPubsubMetadataOrBuilder(int index)

Pub/Sub snapshot metadata.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PubsubSnapshotMetadataOrBuilder

getPubsubMetadataOrBuilderList()

public List<? extends PubsubSnapshotMetadataOrBuilder> getPubsubMetadataOrBuilderList()

Pub/Sub snapshot metadata.

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

Returns
TypeDescription
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
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

string region = 10;

Returns
TypeDescription
ByteString

The bytes for region.

getSourceJobId()

public String getSourceJobId()

The job this snapshot was created from.

string source_job_id = 3;

Returns
TypeDescription
String

The sourceJobId.

getSourceJobIdBytes()

public ByteString getSourceJobIdBytes()

The job this snapshot was created from.

string source_job_id = 3;

Returns
TypeDescription
ByteString

The bytes for sourceJobId.

getState()

public SnapshotState getState()

State of the snapshot.

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

Returns
TypeDescription
SnapshotState

The state.

getStateValue()

public int getStateValue()

State of the snapshot.

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

Returns
TypeDescription
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
TypeDescription
Duration

The ttl.

getTtlBuilder()

public Duration.Builder getTtlBuilder()

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Returns
TypeDescription
Builder

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Returns
TypeDescription
DurationOrBuilder

hasCreationTime()

public boolean hasCreationTime()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the ttl field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreationTime(Timestamp value)

public Snapshot.Builder mergeCreationTime(Timestamp value)

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Snapshot.Builder

mergeFrom(Snapshot other)

public Snapshot.Builder mergeFrom(Snapshot other)
Parameter
NameDescription
otherSnapshot
Returns
TypeDescription
Snapshot.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Snapshot.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Snapshot.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Snapshot.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
Snapshot.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Snapshot.Builder

setCreationTime(Timestamp value)

public Snapshot.Builder setCreationTime(Timestamp value)

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Snapshot.Builder

setDescription(String value)

public Snapshot.Builder setDescription(String value)

User specified description of the snapshot. Maybe empty.

string description = 8;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
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
NameDescription
valuelong

The diskSizeBytes to set.

Returns
TypeDescription
Snapshot.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Snapshot.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Snapshot.Builder
Overrides

setId(String value)

public Snapshot.Builder setId(String value)

The unique ID of this snapshot.

string id = 1;

Parameter
NameDescription
valueString

The id to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for id to set.

Returns
TypeDescription
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
NameDescription
valueString

The projectId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for projectId to set.

Returns
TypeDescription
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
NameDescription
indexint
valuePubsubSnapshotMetadata
Returns
TypeDescription
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
NameDescription
indexint
builderForValuePubsubSnapshotMetadata.Builder
Returns
TypeDescription
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
NameDescription
valueString

The region to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The sourceJobId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for sourceJobId to set.

Returns
TypeDescription
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
NameDescription
valueSnapshotState

The state to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Snapshot.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Snapshot.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Snapshot.Builder
Overrides