target.apidocs.com.google.api.services.dataflow.model.Snapshot.html Maven / Gradle / Ivy
Snapshot (Dataflow API v1b3-rev20231112-2.0.0)
com.google.api.services.dataflow.model
Class Snapshot
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.dataflow.model.Snapshot
-
public final class Snapshot
extends com.google.api.client.json.GenericJson
Represents a snapshot of a job.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Dataflow API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Snapshot()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Snapshot
clone()
String
getCreationTime()
The time this snapshot was created.
String
getDescription()
User specified description of the snapshot.
Long
getDiskSizeBytes()
The disk byte size of the snapshot.
String
getId()
The unique ID of this snapshot.
String
getProjectId()
The project this snapshot belongs to.
List<PubsubSnapshotMetadata>
getPubsubMetadata()
Pub/Sub snapshot metadata.
String
getRegion()
Cloud region where this snapshot lives in, e.g., "us-central1".
String
getSourceJobId()
The job this snapshot was created from.
String
getState()
State of the snapshot.
String
getTtl()
The time after which this snapshot will be automatically deleted.
Snapshot
set(String fieldName,
Object value)
Snapshot
setCreationTime(String creationTime)
The time this snapshot was created.
Snapshot
setDescription(String description)
User specified description of the snapshot.
Snapshot
setDiskSizeBytes(Long diskSizeBytes)
The disk byte size of the snapshot.
Snapshot
setId(String id)
The unique ID of this snapshot.
Snapshot
setProjectId(String projectId)
The project this snapshot belongs to.
Snapshot
setPubsubMetadata(List<PubsubSnapshotMetadata> pubsubMetadata)
Pub/Sub snapshot metadata.
Snapshot
setRegion(String region)
Cloud region where this snapshot lives in, e.g., "us-central1".
Snapshot
setSourceJobId(String sourceJobId)
The job this snapshot was created from.
Snapshot
setState(String state)
State of the snapshot.
Snapshot
setTtl(String ttl)
The time after which this snapshot will be automatically deleted.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getCreationTime
public String getCreationTime()
The time this snapshot was created.
- Returns:
- value or
null
for none
-
setCreationTime
public Snapshot setCreationTime(String creationTime)
The time this snapshot was created.
- Parameters:
creationTime
- creationTime or null
for none
-
getDescription
public String getDescription()
User specified description of the snapshot. Maybe empty.
- Returns:
- value or
null
for none
-
setDescription
public Snapshot setDescription(String description)
User specified description of the snapshot. Maybe empty.
- Parameters:
description
- description or null
for none
-
getDiskSizeBytes
public Long getDiskSizeBytes()
The disk byte size of the snapshot. Only available for snapshots in READY state.
- Returns:
- value or
null
for none
-
setDiskSizeBytes
public Snapshot setDiskSizeBytes(Long diskSizeBytes)
The disk byte size of the snapshot. Only available for snapshots in READY state.
- Parameters:
diskSizeBytes
- diskSizeBytes or null
for none
-
getId
public String getId()
The unique ID of this snapshot.
- Returns:
- value or
null
for none
-
setId
public Snapshot setId(String id)
The unique ID of this snapshot.
- Parameters:
id
- id or null
for none
-
getProjectId
public String getProjectId()
The project this snapshot belongs to.
- Returns:
- value or
null
for none
-
setProjectId
public Snapshot setProjectId(String projectId)
The project this snapshot belongs to.
- Parameters:
projectId
- projectId or null
for none
-
getPubsubMetadata
public List<PubsubSnapshotMetadata> getPubsubMetadata()
Pub/Sub snapshot metadata.
- Returns:
- value or
null
for none
-
setPubsubMetadata
public Snapshot setPubsubMetadata(List<PubsubSnapshotMetadata> pubsubMetadata)
Pub/Sub snapshot metadata.
- Parameters:
pubsubMetadata
- pubsubMetadata or null
for none
-
getRegion
public String getRegion()
Cloud region where this snapshot lives in, e.g., "us-central1".
- Returns:
- value or
null
for none
-
setRegion
public Snapshot setRegion(String region)
Cloud region where this snapshot lives in, e.g., "us-central1".
- Parameters:
region
- region or null
for none
-
getSourceJobId
public String getSourceJobId()
The job this snapshot was created from.
- Returns:
- value or
null
for none
-
setSourceJobId
public Snapshot setSourceJobId(String sourceJobId)
The job this snapshot was created from.
- Parameters:
sourceJobId
- sourceJobId or null
for none
-
getState
public String getState()
State of the snapshot.
- Returns:
- value or
null
for none
-
setState
public Snapshot setState(String state)
State of the snapshot.
- Parameters:
state
- state or null
for none
-
getTtl
public String getTtl()
The time after which this snapshot will be automatically deleted.
- Returns:
- value or
null
for none
-
setTtl
public Snapshot setTtl(String ttl)
The time after which this snapshot will be automatically deleted.
- Parameters:
ttl
- ttl or null
for none
-
set
public Snapshot set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public Snapshot clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy