com.google.cloud.pubsublite

Enum BacklogLocation

java.lang.Object

java.lang.Enum<BacklogLocation>

com.google.cloud.pubsublite.BacklogLocation

All Implemented Interfaces:

Serializable, Comparable<BacklogLocation>

public enum BacklogLocation
extends Enum<BacklogLocation>

BacklogLocation refers to a location with respect to the message backlog.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEGINNING BEGINNING refers to the location of the oldest retained message.
END END refers to the location past all currently published messages, skipping the entire message backlog.

Method Summary

Modifier and Type	Method and Description
static BacklogLocation	valueOf(String name) Returns the enum constant of this type with the specified name.
static BacklogLocation[]	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

Enum Constant Detail

BEGINNING

public static final BacklogLocation BEGINNING

BEGINNING refers to the location of the oldest retained message.

END

public static final BacklogLocation END

END refers to the location past all currently published messages, skipping the entire message backlog.

Method Detail

values

public static BacklogLocation[] 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 (BacklogLocation c : BacklogLocation.values())
    System.out.println(c);

Returns:

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

valueOf

public static BacklogLocation 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