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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Position
extends 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 Google Dataflow API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Position()

Method Summary

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Position

public Position()

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 GenericJson

clone

public Position clone()

Overrides:

clone in class GenericJson