Class Snapshot (0.16.0)
0.91.0 (latest)
0.89.0
0.87.0
0.86.0
0.85.0
0.84.0
0.82.0
0.80.0
0.79.0
0.78.0
0.77.0
0.76.0
0.74.0
0.72.0
0.71.0
0.68.0
0.67.0
0.66.0
0.64.0
0.63.0
0.62.0
0.61.0
0.60.0
0.59.0
0.58.0
0.57.0
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
Static Fields
CREATION_TIME_FIELD_NUMBER
public static final int CREATION_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISK_SIZE_BYTES_FIELD_NUMBER
public static final int DISK_SIZE_BYTES_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
Field Value
public static final int PUBSUB_METADATA_FIELD_NUMBER
Field Value
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Field Value
SOURCE_JOB_ID_FIELD_NUMBER
public static final int SOURCE_JOB_ID_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TTL_FIELD_NUMBER
public static final int TTL_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Snapshot getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Snapshot . Builder newBuilder ()
Returns
newBuilder(Snapshot prototype)
public static Snapshot . Builder newBuilder ( Snapshot prototype )
Parameter
Returns
public static Snapshot parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Snapshot parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Snapshot parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Snapshot parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Snapshot parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Snapshot parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Snapshot parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Snapshot parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Snapshot parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Snapshot parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Snapshot parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Snapshot parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Snapshot> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getCreationTime()
public Timestamp getCreationTime ()
The time this snapshot was created.
.google.protobuf.Timestamp creation_time = 4;
Returns
getCreationTimeOrBuilder()
public TimestampOrBuilder getCreationTimeOrBuilder ()
The time this snapshot was created.
.google.protobuf.Timestamp creation_time = 4;
Returns
getDefaultInstanceForType()
public Snapshot getDefaultInstanceForType ()
Returns
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()
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
getParserForType()
public Parser<Snapshot> getParserForType ()
Returns
Overrides
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.
public PubsubSnapshotMetadata getPubsubMetadata ( int index )
Pub/Sub snapshot metadata.
repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;
Parameter
Name Description
indexint
Returns
public int getPubsubMetadataCount ()
Pub/Sub snapshot metadata.
repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;
Returns
public List<PubsubSnapshotMetadata> getPubsubMetadataList ()
Pub/Sub snapshot metadata.
repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;
Returns
public PubsubSnapshotMetadataOrBuilder getPubsubMetadataOrBuilder ( int index )
Pub/Sub snapshot metadata.
repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;
Parameter
Name Description
indexint
Returns
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
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
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
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()
The time after which this snapshot will be automatically deleted.
.google.protobuf.Duration ttl = 5;
Returns
getTtlOrBuilder()
public DurationOrBuilder getTtlOrBuilder ()
The time after which this snapshot will be automatically deleted.
.google.protobuf.Duration ttl = 5;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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()
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Snapshot . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Snapshot . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Snapshot . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
