Package com.couchbase.client.java.util

Enum AnalyticsIngester

java.lang.Object

java.lang.Enum<AnalyticsIngester>

com.couchbase.client.java.util.AnalyticsIngester

All Implemented Interfaces:

Serializable, Comparable<AnalyticsIngester>

@Public
@Experimental
public enum AnalyticsIngester
extends Enum<AnalyticsIngester>

This class allows to take results from an analytics result and turn it back into KV operations that will be inserted.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnalyticsIngester.IngestMethod	Describes how the data should be ingested back into the kv service.
static class	AnalyticsIngester.IngestOptions

Method Summary

Modifier and Type	Method	Description
static rx.Completable	ingest(Bucket bucket, AnalyticsQuery query)	Takes an AnalyticsQuery and ingests all rows back into the KV layer as documents with default settings applied.
static rx.Completable	ingest(Bucket bucket, AnalyticsQuery query, AnalyticsIngester.IngestOptions options)	Takes an AnalyticsQuery and ingests all rows back into the KV layer as documents.
static AnalyticsIngester	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AnalyticsIngester[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static AnalyticsIngester[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AnalyticsIngester c : AnalyticsIngester.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AnalyticsIngester valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

ingest

public static rx.Completable ingest(Bucket bucket,
                                    AnalyticsQuery query)

Takes an AnalyticsQuery and ingests all rows back into the KV layer as documents with default settings applied.

Parameters:

bucket - the bucket where to write back into.

query - the analytics query to execute.

Returns:

a Completable which suggests once complete or failed.

ingest

public static rx.Completable ingest(Bucket bucket,
                                    AnalyticsQuery query,
                                    AnalyticsIngester.IngestOptions options)

Takes an AnalyticsQuery and ingests all rows back into the KV layer as documents.

Parameters:

bucket - the bucket where to write back into.

query - the analytics query to execute.

options - the ingest options to change default behavior.

Returns:

a Completable which suggests once complete or failed.