# SnapshotDataset

public final class **SnapshotDataset** Creates a dataset that will write to / read from a snapshot.


This dataset attempts to determine whether a valid snapshot exists at the
\`snapshot_path\`, and reads from the snapshot in lieu of using \`input_dataset\`.
If not, it will run the preprocessing pipeline as usual, and write out a
snapshot of the data processed for future use.

<br />

### Nested Classes

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

### Public Methods

|---|---|
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<Object\> | [asOutput](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#asOutput())() Returns the symbolic handle of a tensor. |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [compression](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#compression(java.lang.String))(String compression) |
| static [SnapshotDataset](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset) | [create](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#create(org.tensorflow.op.Scope,%20org.tensorflow.Operand<?>,%20org.tensorflow.Operand<java.lang.String>,%20java.util.List<java.lang.Class<?>>,%20java.util.List<org.tensorflow.Shape>,%20org.tensorflow.op.core.SnapshotDataset.Options...))([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> inputDataset, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<String\> path, List\<Class\<?\>\> outputTypes, List\<[Shape](https://www.tensorflow.org/api_docs/java/org/tensorflow/Shape)\> outputShapes, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) options) Factory method to create a class wrapping a new SnapshotDataset operation. |
| [Output](https://www.tensorflow.org/api_docs/java/org/tensorflow/Output)\<?\> | [handle](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#handle())() |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [mode](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#mode(java.lang.String))(String mode) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [numReaderThreads](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#numReaderThreads(java.lang.Long))(Long numReaderThreads) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [numWriterThreads](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#numWriterThreads(java.lang.Long))(Long numWriterThreads) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [pendingSnapshotExpirySeconds](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#pendingSnapshotExpirySeconds(java.lang.Long))(Long pendingSnapshotExpirySeconds) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [readerBufferSize](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#readerBufferSize(java.lang.Long))(Long readerBufferSize) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [readerPathPrefix](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#readerPathPrefix(java.lang.String))(String readerPathPrefix) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [seed](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#seed(java.lang.Long))(Long seed) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [seed2](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#seed2(java.lang.Long))(Long seed2) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [shardSizeBytes](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#shardSizeBytes(java.lang.Long))(Long shardSizeBytes) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [shuffleOnRead](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#shuffleOnRead(java.lang.Boolean))(Boolean shuffleOnRead) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [snapshotName](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#snapshotName(java.lang.String))(String snapshotName) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [writerBufferSize](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#writerBufferSize(java.lang.Long))(Long writerBufferSize) |
| static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) | [writerPathPrefix](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset#writerPathPrefix(java.lang.String))(String writerPathPrefix) |

### 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)\<Object\> | [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)\<Object\>
**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 [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options)
**compression**
(String compression)

<br />

#### public static [SnapshotDataset](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset)
**create**
([Scope](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/Scope) scope, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<?\> inputDataset, [Operand](https://www.tensorflow.org/api_docs/java/org/tensorflow/Operand)\<String\> path, List\<Class\<?\>\> outputTypes, List\<[Shape](https://www.tensorflow.org/api_docs/java/org/tensorflow/Shape)\> outputShapes, [Options...](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options) options)

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

##### Parameters

| scope | current scope |
| inputDataset | A variant tensor representing the input dataset. |
| path | The path we should write snapshots to / read snapshots from. |
| options | carries optional attributes values |
|---|---|

##### Returns

- a new instance of SnapshotDataset

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

<br />

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

<br />

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

<br />

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

<br />

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

<br />

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

<br />

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

<br />

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

<br />

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

<br />

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

<br />

#### public static [SnapshotDataset.Options](https://www.tensorflow.org/api_docs/java/org/tensorflow/op/core/SnapshotDataset.Options)
**shuffleOnRead**
(Boolean shuffleOnRead)

<br />

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

<br />

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

<br />

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

<br />