com.google.cloud.discoveryengine.v1alpha

Enum FieldConfig.RetrievableOption

java.lang.Object

java.lang.Enum<FieldConfig.RetrievableOption>

com.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<FieldConfig.RetrievableOption>

Enclosing class:

FieldConfig

public static enum FieldConfig.RetrievableOption
extends Enum<FieldConfig.RetrievableOption>
implements com.google.protobuf.ProtocolMessageEnum

 The setting of Retrievable options in schema.
 

Protobuf enum google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption

Enum Constant Summary

Enum Constants

Enum Constant and Description
RETRIEVABLE_DISABLED Retrievable option disabled for a schema field.
RETRIEVABLE_ENABLED Retrievable option enabled for a schema field.
RETRIEVABLE_OPTION_UNSPECIFIED Value used when unset.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	RETRIEVABLE_DISABLED_VALUE Retrievable option disabled for a schema field.
static int	RETRIEVABLE_ENABLED_VALUE Retrievable option enabled for a schema field.
static int	RETRIEVABLE_OPTION_UNSPECIFIED_VALUE Value used when unset.

Method Summary

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

RETRIEVABLE_OPTION_UNSPECIFIED

public static final FieldConfig.RetrievableOption RETRIEVABLE_OPTION_UNSPECIFIED

 Value used when unset.
 

RETRIEVABLE_OPTION_UNSPECIFIED = 0;

RETRIEVABLE_ENABLED

public static final FieldConfig.RetrievableOption RETRIEVABLE_ENABLED

 Retrievable option enabled for a schema field.
 

RETRIEVABLE_ENABLED = 1;

RETRIEVABLE_DISABLED

public static final FieldConfig.RetrievableOption RETRIEVABLE_DISABLED

 Retrievable option disabled for a schema field.
 

RETRIEVABLE_DISABLED = 2;

UNRECOGNIZED

public static final FieldConfig.RetrievableOption UNRECOGNIZED

Field Detail

RETRIEVABLE_OPTION_UNSPECIFIED_VALUE

public static final int RETRIEVABLE_OPTION_UNSPECIFIED_VALUE

 Value used when unset.
 

RETRIEVABLE_OPTION_UNSPECIFIED = 0;

See Also:

Constant Field Values

RETRIEVABLE_ENABLED_VALUE

public static final int RETRIEVABLE_ENABLED_VALUE

 Retrievable option enabled for a schema field.
 

RETRIEVABLE_ENABLED = 1;

See Also:

Constant Field Values

RETRIEVABLE_DISABLED_VALUE

public static final int RETRIEVABLE_DISABLED_VALUE

 Retrievable option disabled for a schema field.
 

RETRIEVABLE_DISABLED = 2;

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static FieldConfig.RetrievableOption 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 FieldConfig.RetrievableOption 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 FieldConfig.RetrievableOption 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<FieldConfig.RetrievableOption> 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 FieldConfig.RetrievableOption valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)