Class Snapshot (0.55.0)

Version 0.55.0

• 0.57.0 (latest)
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

public final class Snapshot extends GeneratedMessageV3 implements SnapshotOrBuilder

Represents a snapshot of a job.

Protobuf type google.dataflow.v1beta3.Snapshot

Inheritance

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

Implements

SnapshotOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CREATION_TIME_FIELD_NUMBER

public static final int CREATION_TIME_FIELD_NUMBER

Field Value
Type	Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
int

DISK_SIZE_BYTES_FIELD_NUMBER

public static final int DISK_SIZE_BYTES_FIELD_NUMBER

Field Value
Type	Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value
Type	Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER

Field Value
Type	Description
int

PUBSUB_METADATA_FIELD_NUMBER

public static final int PUBSUB_METADATA_FIELD_NUMBER

Field Value
Type	Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER

Field Value
Type	Description
int

SOURCE_JOB_ID_FIELD_NUMBER

public static final int SOURCE_JOB_ID_FIELD_NUMBER

Field Value
Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
int

TTL_FIELD_NUMBER

public static final int TTL_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Snapshot getDefaultInstance()

Returns
Type	Description
Snapshot

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Snapshot.Builder newBuilder()

Returns
Type	Description
Snapshot.Builder

newBuilder(Snapshot prototype)

public static Snapshot.Builder newBuilder(Snapshot prototype)

Parameter
Name	Description
prototype	Snapshot

Returns
Type	Description
Snapshot.Builder

parseDelimitedFrom(InputStream input)

public static Snapshot parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Snapshot

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Snapshot

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Snapshot parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Snapshot

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Snapshot

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Snapshot parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Snapshot

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Snapshot

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Snapshot parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Snapshot

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Snapshot

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Snapshot parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Snapshot

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Snapshot

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Snapshot parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Snapshot

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Snapshot

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Snapshot> parser()

Returns
Type	Description
Parser<Snapshot>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCreationTime()

public Timestamp getCreationTime()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
Type	Description
Timestamp	The creationTime.

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.

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.

getParserForType()

public Parser<Snapshot> getParserForType()

Returns
Type	Description
Parser<Snapshot>

Overrides

GeneratedMessageV3.getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Snapshot.Builder newBuilderForType()

Returns
Type	Description
Snapshot.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Snapshot.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Snapshot.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Snapshot.Builder toBuilder()

Returns
Type	Description
Snapshot.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException