Package com.google.cloud.discoveryengine.v1alpha

Enum Engine.RecommendationMetadata.ServingState

java.lang.Object

java.lang.Enum<Engine.RecommendationMetadata.ServingState>

com.google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.ServingState

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Engine.RecommendationMetadata.ServingState>

Enclosing class:

Engine.RecommendationMetadata

public static enum Engine.RecommendationMetadata.ServingState
extends Enum<Engine.RecommendationMetadata.ServingState>
implements com.google.protobuf.ProtocolMessageEnum

 The serving state of the recommendation engine.
 

Protobuf enum google.cloud.discoveryengine.v1alpha.Engine.RecommendationMetadata.ServingState

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	The engine is serving and can be queried.
INACTIVE	The engine is not serving.
SERVING_STATE_UNSPECIFIED	Unspecified serving state.
TUNED	The engine is trained on tuned hyperparameters and can be queried.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACTIVE_VALUE	The engine is serving and can be queried.
static final int	INACTIVE_VALUE	The engine is not serving.
static final int	SERVING_STATE_UNSPECIFIED_VALUE	Unspecified serving state.
static final int	TUNED_VALUE	The engine is trained on tuned hyperparameters and can be queried.

Method Summary

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

SERVING_STATE_UNSPECIFIED

public static final Engine.RecommendationMetadata.ServingState SERVING_STATE_UNSPECIFIED

 Unspecified serving state.
 

SERVING_STATE_UNSPECIFIED = 0;

INACTIVE

public static final Engine.RecommendationMetadata.ServingState INACTIVE

 The engine is not serving.
 

INACTIVE = 1;

ACTIVE

public static final Engine.RecommendationMetadata.ServingState ACTIVE

 The engine is serving and can be queried.
 

ACTIVE = 2;

TUNED

public static final Engine.RecommendationMetadata.ServingState TUNED

 The engine is trained on tuned hyperparameters and can be
 queried.
 

TUNED = 3;

UNRECOGNIZED

public static final Engine.RecommendationMetadata.ServingState UNRECOGNIZED

Field Details

SERVING_STATE_UNSPECIFIED_VALUE

public static final int SERVING_STATE_UNSPECIFIED_VALUE

 Unspecified serving state.
 

SERVING_STATE_UNSPECIFIED = 0;

See Also:

• Constant Field Values

INACTIVE_VALUE

public static final int INACTIVE_VALUE

 The engine is not serving.
 

INACTIVE = 1;

See Also:

• Constant Field Values

ACTIVE_VALUE

public static final int ACTIVE_VALUE

 The engine is serving and can be queried.
 

ACTIVE = 2;

See Also:

• Constant Field Values

TUNED_VALUE

public static final int TUNED_VALUE

 The engine is trained on tuned hyperparameters and can be
 queried.
 

TUNED = 3;

See Also:

• Constant Field Values

Method Details

values

public static Engine.RecommendationMetadata.ServingState[] values()

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

Returns:

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

valueOf

public static Engine.RecommendationMetadata.ServingState 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 Engine.RecommendationMetadata.ServingState valueOf(int value)

Deprecated.

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:

value - 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

forNumber

public static Engine.RecommendationMetadata.ServingState 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<Engine.RecommendationMetadata.ServingState> 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 com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Engine.RecommendationMetadata.ServingState valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)

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:

desc - 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