org.tensorflow.op.io

Class QueueClose

java.lang.Object

org.tensorflow.op.PrimitiveOp

org.tensorflow.op.io.QueueClose

All Implemented Interfaces:

Op

@Operator(group="io")
public final class QueueClose
extends PrimitiveOp

Closes the given queue.

This operation signals that no more elements will be enqueued in the given queue. Subsequent Enqueue(Many) operations will fail. Subsequent Dequeue(Many) operations will continue to succeed if sufficient elements remain in the queue. Subsequent Dequeue(Many) operations that would block will fail immediately.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueueClose.Options Optional attributes for QueueClose

Field Summary

Fields inherited from class org.tensorflow.op.PrimitiveOp

operation

Method Summary

Modifier and Type	Method and Description
static QueueClose.Options	cancelPendingEnqueues(Boolean cancelPendingEnqueues)
static QueueClose	create(Scope scope, Operand<?> handle, QueueClose.Options... options) Factory method to create a class wrapping a new QueueClose operation.

Methods inherited from class org.tensorflow.op.PrimitiveOp

equals, hashCode, op, toString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static QueueClose create(Scope scope,
                                Operand<?> handle,
                                QueueClose.Options... options)

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

Parameters:

scope - current scope

handle - The handle to a queue.

options - carries optional attributes values

Returns:

a new instance of QueueClose

cancelPendingEnqueues

public static QueueClose.Options cancelPendingEnqueues(Boolean cancelPendingEnqueues)

Parameters:

cancelPendingEnqueues - If true, all pending enqueue requests that are blocked on the given queue will be canceled.