com.google.cloud.datastream.v1

Enum Stream.State

java.lang.Object

java.lang.Enum<Stream.State>

com.google.cloud.datastream.v1.Stream.State

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Stream.State>

Enclosing class:

Stream

public static enum Stream.State
extends Enum<Stream.State>
implements com.google.protobuf.ProtocolMessageEnum

 Stream state.
 

Protobuf enum google.cloud.datastream.v1.Stream.State

Enum Constant Summary

Enum Constants

Enum Constant and Description
DRAINING The Stream is no longer reading new events, but still writing events in the buffer.
FAILED The stream is experiencing an error that is preventing data from being streamed.
FAILED_PERMANENTLY The stream has experienced a terminal failure.
MAINTENANCE The stream is in maintenance mode.
NOT_STARTED The stream has been created but has not yet started streaming data.
PAUSED The stream is paused.
RUNNING The stream is running.
STARTING The stream is starting, but not yet running.
STATE_UNSPECIFIED Unspecified stream state.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	DRAINING_VALUE The Stream is no longer reading new events, but still writing events in the buffer.
static int	FAILED_PERMANENTLY_VALUE The stream has experienced a terminal failure.
static int	FAILED_VALUE The stream is experiencing an error that is preventing data from being streamed.
static int	MAINTENANCE_VALUE The stream is in maintenance mode.
static int	NOT_STARTED_VALUE The stream has been created but has not yet started streaming data.
static int	PAUSED_VALUE The stream is paused.
static int	RUNNING_VALUE The stream is running.
static int	STARTING_VALUE The stream is starting, but not yet running.
static int	STATE_UNSPECIFIED_VALUE Unspecified stream state.

Method Summary

Modifier and Type	Method and Description
static Stream.State	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<Stream.State>	internalGetValueMap()
static Stream.State	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Stream.State	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Stream.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static Stream.State[]	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

STATE_UNSPECIFIED

public static final Stream.State STATE_UNSPECIFIED

 Unspecified stream state.
 

STATE_UNSPECIFIED = 0;

NOT_STARTED

public static final Stream.State NOT_STARTED

 The stream has been created but has not yet started streaming data.
 

NOT_STARTED = 1;

RUNNING

public static final Stream.State RUNNING

 The stream is running.
 

RUNNING = 2;

PAUSED

public static final Stream.State PAUSED

 The stream is paused.
 

PAUSED = 3;

MAINTENANCE

public static final Stream.State MAINTENANCE

 The stream is in maintenance mode.
 Updates are rejected on the resource in this state.
 

MAINTENANCE = 4;

FAILED

public static final Stream.State FAILED

 The stream is experiencing an error that is preventing data from being
 streamed.
 

FAILED = 5;

FAILED_PERMANENTLY

public static final Stream.State FAILED_PERMANENTLY

 The stream has experienced a terminal failure.
 

FAILED_PERMANENTLY = 6;

STARTING

public static final Stream.State STARTING

 The stream is starting, but not yet running.
 

STARTING = 7;

DRAINING

public static final Stream.State DRAINING

 The Stream is no longer reading new events, but still writing events in
 the buffer.
 

DRAINING = 8;

UNRECOGNIZED

public static final Stream.State UNRECOGNIZED

Field Detail

STATE_UNSPECIFIED_VALUE

public static final int STATE_UNSPECIFIED_VALUE

 Unspecified stream state.
 

STATE_UNSPECIFIED = 0;

See Also:

Constant Field Values

NOT_STARTED_VALUE

public static final int NOT_STARTED_VALUE

 The stream has been created but has not yet started streaming data.
 

NOT_STARTED = 1;

See Also:

Constant Field Values

RUNNING_VALUE

public static final int RUNNING_VALUE

 The stream is running.
 

RUNNING = 2;

See Also:

Constant Field Values

PAUSED_VALUE

public static final int PAUSED_VALUE

 The stream is paused.
 

PAUSED = 3;

See Also:

Constant Field Values

MAINTENANCE_VALUE

public static final int MAINTENANCE_VALUE

 The stream is in maintenance mode.
 Updates are rejected on the resource in this state.
 

MAINTENANCE = 4;

See Also:

Constant Field Values

FAILED_VALUE

public static final int FAILED_VALUE

 The stream is experiencing an error that is preventing data from being
 streamed.
 

FAILED = 5;

See Also:

Constant Field Values

FAILED_PERMANENTLY_VALUE

public static final int FAILED_PERMANENTLY_VALUE

 The stream has experienced a terminal failure.
 

FAILED_PERMANENTLY = 6;

See Also:

Constant Field Values

STARTING_VALUE

public static final int STARTING_VALUE

 The stream is starting, but not yet running.
 

STARTING = 7;

See Also:

Constant Field Values

DRAINING_VALUE

public static final int DRAINING_VALUE

 The Stream is no longer reading new events, but still writing events in
 the buffer.
 

DRAINING = 8;

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static Stream.State 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

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static Stream.State valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static Stream.State forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<Stream.State> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Stream.State valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)