Send feedback
Class Snapshot (0.49.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.49.0 keyboard_arrow_down
public final class Snapshot extends GeneratedMessageV3 implements SnapshotOrBuilder
Represents a snapshot of a job.
Protobuf type google.dataflow.v1beta3.Snapshot
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Snapshot . Builder newBuilder ()
newBuilder(Snapshot prototype)
public static Snapshot . Builder newBuilder ( Snapshot prototype )
Parameter
Name
Description
prototype
Snapshot
public static Snapshot parseDelimitedFrom ( InputStream input )
public static Snapshot parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Snapshot parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Snapshot parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Snapshot parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Snapshot parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Snapshot parseFrom ( CodedInputStream input )
public static Snapshot parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Snapshot parseFrom ( InputStream input )
public static Snapshot parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Snapshot parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Snapshot parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Snapshot> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
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;
getDefaultInstanceForType()
public Snapshot getDefaultInstanceForType ()
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
Type
Description
ByteString
The bytes for id.
getParserForType()
public Parser<Snapshot> getParserForType ()
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
index
int
public int getPubsubMetadataCount ()
Pub/Sub snapshot metadata.
repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;
Returns
Type
Description
int
public List<PubsubSnapshotMetadata> getPubsubMetadataList ()
Pub/Sub snapshot metadata.
repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;
public PubsubSnapshotMetadataOrBuilder getPubsubMetadataOrBuilder ( int index )
Pub/Sub snapshot metadata.
repeated .google.dataflow.v1beta3.PubsubSnapshotMetadata pubsub_metadata = 7;
Parameter
Name
Description
index
int
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
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;
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
Type
Description
Duration
The ttl.
getTtlOrBuilder()
public DurationOrBuilder getTtlOrBuilder ()
The time after which this snapshot will be automatically deleted.
.google.protobuf.Duration ttl = 5;
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
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Snapshot . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Snapshot . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public Snapshot . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]