# Barrier

public final class **Barrier** Defines a barrier that persists across different graph executions.


A barrier represents a key-value map, where each key is a string, and
each value is a tuple of tensors.


At runtime, the barrier contains 'complete' and 'incomplete'
elements. A complete element has defined tensors for all components of
its value tuple, and may be accessed using BarrierTakeMany. An
incomplete element has some undefined components in its value tuple,
and may be updated using BarrierInsertMany.

<br />

<br />

### Nested Classes

|---|---|---|---|
| class | [Barrier.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options) || Optional attributes for `https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier` |

### Public Methods

|---|---|
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<String\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier#asOutput())() Returns the symbolic handle of a tensor. |
| static [Barrier.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options) | [capacity](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier#capacity(java.lang.Long))(Long capacity) |
| static [Barrier.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options) | [container](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier#container(java.lang.String))(String container) |
| static [Barrier](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier#create(org.tensorflow.op.Scope,%20java.util.List<java.lang.Class<?>>,%20org.tensorflow.op.core.Barrier.Options...))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, List\<Class\<?\>\> componentTypes, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options) options) Factory method to create a class wrapping a new Barrier operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<String\> | [handle](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier#handle())() The handle to the barrier. |
| static [Barrier.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options) | [shapes](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier#shapes(java.util.List<org.tensorflow.Shape>))(List\<[Shape](https://www.tensorflow.org/api_docs/java/org/tensorflow/Shape)\> shapes) |
| static [Barrier.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options) | [sharedName](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier#sharedName(java.lang.String))(String sharedName) |

### Inherited Methods

From class [org.tensorflow.op.PrimitiveOp](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp)

|---|---|
| final boolean | [equals](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#equals(java.lang.Object))(Object obj) |
| final int | [hashCode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#hashCode())() |
| [Operation](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation) | [op](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#op())() Returns the underlying `https://www.tensorflow.org/api_docs/java/org/tensorflow/Operation` |
| final String | [toString](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/PrimitiveOp#toString())() |

From class java.lang.Object

|---|---|
| boolean | equals(Object arg0) |
| final Class\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| String | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

From interface [org.tensorflow.Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)

|---|---|
| abstract [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<String\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand#asOutput())() Returns the symbolic handle of a tensor. |

## Public Methods

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<String\>
**asOutput**
()

Returns the symbolic handle of a tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is
used to obtain a symbolic handle that represents the computation of the input.

<br />

#### public static [Barrier.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options)
**capacity**
(Long capacity)

<br />

##### Parameters

| capacity | The capacity of the barrier. The default capacity is MAX_INT32, which is the largest capacity of the underlying queue. |
|---|---|

#### public static [Barrier.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options)
**container**
(String container)

<br />

##### Parameters

| container | If non-empty, this barrier is placed in the given container. Otherwise, a default container is used. |
|---|---|

#### public static [Barrier](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier)
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, List\<Class\<?\>\> componentTypes, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options) options)

Factory method to create a class wrapping a new Barrier operation.

##### Parameters

| scope | current scope |
| componentTypes | The type of each component in a value. |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of Barrier

#### public [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<String\>
**handle**
()

The handle to the barrier.

#### public static [Barrier.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options)
**shapes**
(List\<[Shape](https://www.tensorflow.org/api_docs/java/org/tensorflow/Shape)\> shapes)

<br />

##### Parameters

| shapes | The shape of each component in a value. Each shape must be 1 in the first dimension. The length of this attr must be the same as the length of component_types. |
|---|---|

#### public static [Barrier.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/Barrier.Options)
**sharedName**
(String sharedName)

<br />

##### Parameters

| sharedName | If non-empty, this barrier will be shared under the given name across multiple sessions. |
|---|---|