com.google.api.core

Enum ApiService.State

java.lang.Object

java.lang.Enum<ApiService.State>

com.google.api.core.ApiService.State

All Implemented Interfaces:

Serializable, Comparable<ApiService.State>

Enclosing interface:

ApiService

@BetaApi
public static enum ApiService.State
extends Enum<ApiService.State>

The lifecycle states of a service.

The ordering of the ApiService.State enum is defined such that if there is a state transition from A -> B then A.compareTo(B) < 0. N.B. The converse is not true, i.e. if A.compareTo(B) < 0 then there is not guaranteed to be a valid state transition A -> B.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED A service in this state has encountered a problem and may not be operational.
NEW A service in this state is inactive.
RUNNING A service in this state is operational.
STARTING A service in this state is transitioning to RUNNING.
STOPPING A service in this state is transitioning to TERMINATED.
TERMINATED A service in this state has completed execution normally.

Method Summary

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

FAILED

public static final ApiService.State FAILED

A service in this state has encountered a problem and may not be operational. It cannot be started nor stopped.

NEW

public static final ApiService.State NEW

A service in this state is inactive. It does minimal work and consumes minimal resources.

RUNNING

public static final ApiService.State RUNNING

A service in this state is operational.

STARTING

public static final ApiService.State STARTING

A service in this state is transitioning to RUNNING.

STOPPING

public static final ApiService.State STOPPING

A service in this state is transitioning to TERMINATED.

TERMINATED

public static final ApiService.State TERMINATED

A service in this state has completed execution normally. It does minimal work and consumes minimal resources.

Method Detail

values

public static ApiService.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 (ApiService.State c : ApiService.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 ApiService.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