KeyedWorkItemCoder (Apache Beam SDK for Java, version 0.5.0)

X-Mailer: ASF-Git Admin Mailer Subject: [33/52] [abbrv] [partial] beam-site git commit: Regenerate website archived-at: Mon, 06 Feb 2017 17:32:11 -0000 http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItemCoder.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItemCoder.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItemCoder.html new file mode 100644 index 0000000..f80b469 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItemCoder.html @@ -0,0 +1,473 @@ + + + + + + +KeyedWorkItemCoder (Apache Beam SDK for Java, version 0.5.0) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.beam.sdk.coders.StandardCoder<KeyedWorkItem<K,ElemT>>
- +
  - org.apache.beam.runners.core.KeyedWorkItemCoder<K,ElemT>
  +
+

+
+
All Implemented Interfaces:
+
Serializable, Coder<KeyedWorkItem<K,ElemT>>
+
+
+
+
```
public class KeyedWorkItemCoder<K,ElemT>
+extends StandardCoder<KeyedWorkItem<K,ElemT>>
```
+
A Coder for KeyedWorkItems.
+
+
See Also:
+
Serialized Form
+
+

+ +

+ + +
Nested Class Summary
+
- + + +
  Nested classes/interfaces inherited from interface org.apache.beam.sdk.coders.Coder
  +Coder.Context, Coder.NonDeterministicException
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`consistentWithEquals()` + Returns `true` if this `Coder` is injective with respect to `Object.equals(java.lang.Object)`. +
`KeyedWorkItem<K,ElemT>`	`decode(InputStream inStream, + Coder.Context context)` + Decodes a value of type `T` from the given input stream in + the given context. +
`void`	`encode(KeyedWorkItem<K,ElemT> value, + OutputStream outStream, + Coder.Context context)` + Encodes the given value of type `T` onto the given output stream + in the given context. +
`List<? extends Coder<?>>`	`getCoderArguments()` + If this is a `Coder` for a parameterized type, returns the + list of `Coder`s being used for each of the parameters, or + returns `null` if this cannot be done or this is not a + parameterized type. +
`Coder<ElemT>`	`getElementCoder()`
`Coder<K>`	`getKeyCoder()`
`static <K,ElemT> KeyedWorkItemCoder<K,ElemT>`	`of(Coder<K> keyCoder, + Coder<ElemT> elemCoder, + Coder<? extends BoundedWindow> windowCoder)` + Create a new `KeyedWorkItemCoder` with the provided key coder, element coder, and window + coder. +
`static <K,ElemT> KeyedWorkItemCoder<K,ElemT>`	`of(List<Coder<?>> components)`
`void`	`verifyDeterministic()` + Throw `Coder.NonDeterministicException` if the coding is not deterministic. +

+ + +
Methods inherited from class org.apache.beam.sdk.coders.StandardCoder
+asCloudObject, equals, getAllowedEncodings, getComponents, getEncodedElementByteSize, getEncodedTypeDescriptor, getEncodingId, hashCode, initializeCloudObject, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, toString, verifyDeterministic, verifyDeter ministic

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Method Detail
  + + + +
  - +
    of
    +
```
public static <K,ElemT> KeyedWorkItemCoder<K,ElemT> of(Coder<K> keyCoder,
+                                                       Coder<ElemT> elemCoder,
+                                                       Coder<? extends BoundedWindow> windowCoder)
```
    +
    Create a new KeyedWorkItemCoder with the provided key coder, element coder, and window + coder.
    +
  + + + +
  - +
    of
    +
```
public static <K,ElemT> KeyedWorkItemCoder<K,ElemT> of(List<Coder<?>> components)
```
    +
  + + + +
  - +
    getKeyCoder
    +
```
public Coder<K> getKeyCoder()
```
    +
  + + + +
  - +
    getElementCoder
    +
```
public Coder<ElemT> getElementCoder()
```
    +
  + + + +
  - +
    encode
    +
```
public void encode(KeyedWorkItem<K,ElemT> value,
+                   OutputStream outStream,
+                   Coder.Context context)
+            throws CoderException,
+                   IOException
```
    +
    Description copied from interface: Coder
    +
    Encodes the given value of type T onto the given output stream + in the given context.
    +
    +
    Throws:
    +
    CoderException - if the value could not be encoded for some reason
    +
    IOException - if writing to the OutputStream fails + for some reason
    +
    +
  + + + +
  - +
    decode
    +
```
public KeyedWorkItem<K,ElemT> decode(InputStream inStream,
+                                     Coder.Context context)
+                              throws CoderException,
+                                     IOException
```
    +
    Description copied from interface: Coder
    +
    Decodes a value of type T from the given input stream in + the given context. Returns the decoded value.
    +
    +
    Throws:
    +
    CoderException - if the value could not be decoded for some reason
    +
    IOException - if reading from the InputStream fails + for some reason
    +
    +
  + + + +
  - +
    getCoderArguments
    +
```
public List<? extends Coder<?>> getCoderArguments()
```
    +
    Description copied from interface: Coder
    +
    If this is a Coder for a parameterized type, returns the + list of Coders being used for each of the parameters, or + returns null if this cannot be done or this is not a + parameterized type.
    +
  + + + +
  - +
    verifyDeterministic
    +
```
public void verifyDeterministic()
+                         throws Coder.NonDeterministicException
```
    +
    Description copied from interface: Coder
    +
    Throw Coder.NonDeterministicException if the coding is not deterministic. + +
    In order for a Coder to be considered deterministic, + the following must be true: +
    - two values that compare as equal (via Object.equals() + or Comparable.compareTo(), if supported) have the same + encoding. +
    - the Coder always produces a canonical encoding, which is the + same for an instance of an object even if produced on different + computers at different times. +
    +
    +
    Throws:
    +
    Coder.NonDeterministicException - if this coder is not deterministic.
    +
    +
  + + + +
  - +
    consistentWithEquals
    +
```
public boolean consistentWithEquals()
```
    +
    Returns true if this Coder is injective with respect to Object.equals(java.lang.Object). + +
    Whenever the encoded bytes of two values are equal, then the original values are equal + according to Objects.equals(). Note that this is well-defined for null. + +
    This condition is most notably false for arrays. More generally, this condition is false + whenever equals() compares object identity, rather than performing a + semantic/structural comparison.. + + KeyedWorkItemCoder is not consistent with equals as it can return a + KeyedWorkItem of a type different from the originally encoded type.
    +
    +
    Specified by:
    +
    consistentWithEquals in interface Coder<KeyedWorkItem<K,ElemT>>
    +
    Overrides:
    +
    consistentWithEquals in class StandardCoder<KeyedWorkItem<K,ElemT>>
    +
    Returns:
    +
    false for StandardCoder unless overridden.
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html new file mode 100644 index 0000000..393d342 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItems.ComposedKeyedWorkItem.html @@ -0,0 +1,351 @@ + + + + + + +KeyedWorkItems.ComposedKeyedWorkItem (Apache Beam SDK for Java, version 0.5.0) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.beam.runners.core.KeyedWorkItems.ComposedKeyedWorkItem<K,ElemT>
+

+
+
All Implemented Interfaces:
+
KeyedWorkItem<K,ElemT>
+
+
+
Enclosing class:
+
KeyedWorkItems
+
+
+
+
```
public static class KeyedWorkItems.ComposedKeyedWorkItem<K,ElemT>
+extends Object
+implements KeyedWorkItem<K,ElemT>
```
+
A KeyedWorkItem composed of an underlying key, TimerInternals.TimerData iterable, and element + iterable.
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Iterable<WindowedValue<ElemT>>`	`elementsIterable()` + Returns an iterable containing the elements. +
`boolean`	`equals(Object other)`
`int`	`hashCode()`
`K`	`key()` + Returns the key. +
`Iterable<TimerInternals.TimerData>`	`timersIterable()` + Returns an iterable containing the timers. +
`String`	`toString()`

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Method Detail
  + + + +
  - +
    key
    +
```
public K key()
```
    +
    Description copied from interface: KeyedWorkItem
    +
    Returns the key.
    +
    +
    Specified by:
    +
    key in interface KeyedWorkItem<K,ElemT>
    +
    +
  + + + +
  - +
    timersIterable
    +
```
public Iterable<TimerInternals.TimerData> timersIterable()
```
    +
    Description copied from interface: KeyedWorkItem
    +
    Returns an iterable containing the timers.
    +
    +
    Specified by:
    +
    timersIterable in interface KeyedWorkItem<K,ElemT>
    +
    +
  + + + +
  - +
    elementsIterable
    +
```
public Iterable<WindowedValue<ElemT>> elementsIterable()
```
    +
    Description copied from interface: KeyedWorkItem
    +
    Returns an iterable containing the elements.
    +
    +
    Specified by:
    +
    elementsIterable in interface KeyedWorkItem<K,ElemT>
    +
    +
  + + + +
  - +
    equals
    +
```
public boolean equals(Object other)
```
    +
    +
    Overrides:
    +
    equals in class Object
    +
    +
  + + + +
  - +
    hashCode
    +
```
public int hashCode()
```
    +
    +
    Overrides:
    +
    hashCode in class Object
    +
    +
  + + + +
  - +
    toString
    +
```
public String toString()
```
    +
    +
    Overrides:
    +
    toString in class Object
    +
    +
  +
+

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItems.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItems.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItems.html new file mode 100644 index 0000000..f420792 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/KeyedWorkItems.html @@ -0,0 +1,362 @@ + + + + + + +KeyedWorkItems (Apache Beam SDK for Java, version 0.5.0) + + + + + + + + +

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.beam.runners.core.KeyedWorkItems
+

+
+
+
```
public class KeyedWorkItems
+extends Object
```
+
Static utility methods that provide KeyedWorkItem implementations.
+

+ +

+ + +

Nested Class Summary

+ + + + + + + + + + +

Nested Classes
Modifier and Type	Class and Description
`static class`	`KeyedWorkItems.ComposedKeyedWorkItem<K,ElemT>` + A `KeyedWorkItem` composed of an underlying key, `TimerInternals.TimerData` iterable, and element + iterable. +

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
KeyedWorkItems()
+

Constructors
Constructor and Description
`KeyedWorkItems()`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <K,ElemT> KeyedWorkItem<K,ElemT>`	`elementsWorkItem(K key, + Iterable<WindowedValue<ElemT>> elementsIterable)` + Returns an implementation of `KeyedWorkItem` that wraps around an elements iterable. +
`static <K,ElemT> KeyedWorkItem<K,ElemT>`	`timersWorkItem(K key, + Iterable<TimerInternals.TimerData> timersIterable)` + Returns an implementation of `KeyedWorkItem` that wraps around an timers iterable. +
`static <K,ElemT> KeyedWorkItem<K,ElemT>`	`workItem(K key, + Iterable<TimerInternals.TimerData> timersIterable, + Iterable<WindowedValue<ElemT>> elementsIterable)` + Returns an implementation of `KeyedWorkItem` that wraps around + an timers iterable and an elements iterable. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +
Constructor Detail
+ + + +
- +
  KeyedWorkItems
  +
```
public KeyedWorkItems()
```
  +
+

+ +

+ + +

Method Detail

+ + + + + +

elementsWorkItem

public static <K,ElemT> KeyedWorkItem<K,ElemT> elementsWorkItem(K key,
+                                                                Iterable<WindowedValue<ElemT>> elementsIterable)

Returns an implementation of KeyedWorkItem that wraps around an elements iterable.

Type Parameters:: K - the key type; ElemT - the element type

+ + + + + +

timersWorkItem

public static <K,ElemT> KeyedWorkItem<K,ElemT> timersWorkItem(K key,
+                                                              Iterable<TimerInternals.TimerData> timersIterable)

Returns an implementation of KeyedWorkItem that wraps around an timers iterable.

Type Parameters:: K - the key type; ElemT - the element type

+ + + + + +

workItem

public static <K,ElemT> KeyedWorkItem<K,ElemT> workItem(K key,
+                                                        Iterable<TimerInternals.TimerData> timersIterable,
+                                                        Iterable<WindowedValue<ElemT>> elementsIterable)

Returns an implementation of KeyedWorkItem that wraps around + an timers iterable and an elements iterable.

Type Parameters:: K - the key type; ElemT - the element type

+ + +

Skip navigation links

+ + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

Class KeyedWorkItemCoder<K,ElemT>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.coders.Coder

Method Summary

Methods inherited from class org.apache.beam.sdk.coders.StandardCoder

Methods inherited from class java.lang.Object

Method Detail

of

of

getKeyCoder

getElementCoder

encode

decode

getCoderArguments

verifyDeterministic

consistentWithEquals

Class KeyedWorkItems.ComposedKeyedWorkItem<K,ElemT>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

key

timersIterable

elementsIterable

equals

hashCode

toString

Class KeyedWorkItems

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyedWorkItems

Method Detail

elementsWorkItem

timersWorkItem

workItem