target.apidocs.com.google.api.services.dataflow.model.Position.html Maven / Gradle / Ivy
Position (Dataflow API v1b3-rev20231112-2.0.0)
com.google.api.services.dataflow.model
Class Position
- 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.Position
-
public final class Position
extends com.google.api.client.json.GenericJson
Position defines a position within a collection of data. The value can be either the end
position, a key (used with ordered collections), a byte offset, or a record index.
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
Position()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Position
clone()
Long
getByteOffset()
Position is a byte offset.
ConcatPosition
getConcatPosition()
CloudPosition is a concat position.
Boolean
getEnd()
Position is past all other positions.
String
getKey()
Position is a string key, ordered lexicographically.
Long
getRecordIndex()
Position is a record index.
String
getShufflePosition()
CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
Position
set(String fieldName,
Object value)
Position
setByteOffset(Long byteOffset)
Position is a byte offset.
Position
setConcatPosition(ConcatPosition concatPosition)
CloudPosition is a concat position.
Position
setEnd(Boolean end)
Position is past all other positions.
Position
setKey(String key)
Position is a string key, ordered lexicographically.
Position
setRecordIndex(Long recordIndex)
Position is a record index.
Position
setShufflePosition(String shufflePosition)
CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
-
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
-
getByteOffset
public Long getByteOffset()
Position is a byte offset.
- Returns:
- value or
null
for none
-
setByteOffset
public Position setByteOffset(Long byteOffset)
Position is a byte offset.
- Parameters:
byteOffset
- byteOffset or null
for none
-
getConcatPosition
public ConcatPosition getConcatPosition()
CloudPosition is a concat position.
- Returns:
- value or
null
for none
-
setConcatPosition
public Position setConcatPosition(ConcatPosition concatPosition)
CloudPosition is a concat position.
- Parameters:
concatPosition
- concatPosition or null
for none
-
getEnd
public Boolean getEnd()
Position is past all other positions. Also useful for the end position of an unbounded range.
- Returns:
- value or
null
for none
-
setEnd
public Position setEnd(Boolean end)
Position is past all other positions. Also useful for the end position of an unbounded range.
- Parameters:
end
- end or null
for none
-
getKey
public String getKey()
Position is a string key, ordered lexicographically.
- Returns:
- value or
null
for none
-
setKey
public Position setKey(String key)
Position is a string key, ordered lexicographically.
- Parameters:
key
- key or null
for none
-
getRecordIndex
public Long getRecordIndex()
Position is a record index.
- Returns:
- value or
null
for none
-
setRecordIndex
public Position setRecordIndex(Long recordIndex)
Position is a record index.
- Parameters:
recordIndex
- recordIndex or null
for none
-
getShufflePosition
public String getShufflePosition()
CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
- Returns:
- value or
null
for none
-
setShufflePosition
public Position setShufflePosition(String shufflePosition)
CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).
- Parameters:
shufflePosition
- shufflePosition or null
for none
-
set
public Position set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public Position 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