Class Snapshot

public final class Snapshot extends GeneratedMessageV3 implements SnapshotOrBuilder

Represents a snapshot of a job.

Protobuf type google.dataflow.v1beta3.Snapshot

Implements

SnapshotOrBuilder

Static Fields

CREATION_TIME_FIELD_NUMBER

public static final int CREATION_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISK_SIZE_BYTES_FIELD_NUMBER

public static final int DISK_SIZE_BYTES_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PUBSUB_METADATA_FIELD_NUMBER

public static final int PUBSUB_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_JOB_ID_FIELD_NUMBER

public static final int SOURCE_JOB_ID_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

TTL_FIELD_NUMBER

public static final int TTL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Snapshot getDefaultInstance()
Returns
TypeDescription
Snapshot

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Snapshot.Builder newBuilder()
Returns
TypeDescription
Snapshot.Builder

newBuilder(Snapshot prototype)

public static Snapshot.Builder newBuilder(Snapshot prototype)
Parameter
NameDescription
prototypeSnapshot
Returns
TypeDescription
Snapshot.Builder

parseDelimitedFrom(InputStream input)

public static Snapshot parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Snapshot parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Snapshot parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Snapshot parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Snapshot parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Snapshot parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Snapshot parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Snapshot
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Snapshot> parser()
Returns
TypeDescription
Parser<Snapshot>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreationTime()

public Timestamp getCreationTime()

The time this snapshot was created.

.google.protobuf.Timestamp creation_time = 4;

Returns
TypeDescription
Timestamp

The creationTime.

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.

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.

getParserForType()

public Parser<Snapshot> getParserForType()
Returns
TypeDescription
Parser<Snapshot>
Overrides

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

getTtlOrBuilder()

public DurationOrBuilder getTtlOrBuilder()

The time after which this snapshot will be automatically deleted.

.google.protobuf.Duration ttl = 5;

Returns
TypeDescription
DurationOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Snapshot.Builder newBuilderForType()
Returns
TypeDescription
Snapshot.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Snapshot.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Snapshot.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Snapshot.Builder toBuilder()
Returns
TypeDescription
Snapshot.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException