CachingOptions (Apache Crunch 0.9.0 API)

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Use

Tree

Deprecated

Index

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.crunch
Class CachingOptions

java.lang.Object
  org.apache.crunch.CachingOptions

public class CachingOptions
extends Object
extends Object

Options for controlling how a PCollection<T> is cached for subsequent processing. Different pipeline execution frameworks may use some or all of these options when deciding how to cache a given PCollection depending on the implementation details of the framework.

Nested Class Summary

static class CachingOptions.Builder
          A Builder class to use for setting the CachingOptions for a PCollection.

Field Summary

static CachingOptions DEFAULT
          An instance of CachingOptions with the default caching settings.

Method Summary

static CachingOptions.Builder builder()
          Creates a new CachingOptions.Builder instance to use for specifying the caching options for a particular PCollection<T>.

boolean deserialized()
          Whether the data should remain deserialized in the cache, which trades off CPU processing time for additional storage overhead.

int replicas()
          Returns the number of replicas of the data that should be maintained in the cache.

boolean useDisk()
          Whether the framework may cache data on disk.

boolean useMemory()
          Whether the framework may cache data in memory without writing it to disk.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Nested Class Summary
`static class`	`CachingOptions.Builder` A Builder class to use for setting the `CachingOptions` for a `PCollection`.

Field Summary
`static CachingOptions`	`DEFAULT` An instance of `CachingOptions` with the default caching settings.

Method Summary
`static CachingOptions.Builder`	`builder()` Creates a new `CachingOptions.Builder` instance to use for specifying the caching options for a particular `PCollection<T>`.
`boolean`	`deserialized()` Whether the data should remain deserialized in the cache, which trades off CPU processing time for additional storage overhead.
`int`	`replicas()` Returns the number of replicas of the data that should be maintained in the cache.
`boolean`	`useDisk()` Whether the framework may cache data on disk.
`boolean`	`useMemory()` Whether the framework may cache data in memory without writing it to disk.

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

Field Detail

DEFAULT

public static final CachingOptions DEFAULT

An instance of CachingOptions with the default caching settings.

Method Detail

useDisk

public boolean useDisk()

Whether the framework may cache data on disk.

useMemory

public boolean useMemory()

Whether the framework may cache data in memory without writing it to disk.

deserialized

public boolean deserialized()

Whether the data should remain deserialized in the cache, which trades off CPU processing time for additional storage overhead.

replicas

public int replicas()

Returns the number of replicas of the data that should be maintained in the cache.

builder

public static CachingOptions.Builder builder()

Creates a new CachingOptions.Builder instance to use for specifying the caching options for a particular PCollection<T>.

Returns: