com.google.api

Enum FieldBehavior

java.lang.Object

java.lang.Enum<FieldBehavior>

com.google.api.FieldBehavior

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<FieldBehavior>

public enum FieldBehavior
extends java.lang.Enum<FieldBehavior>
implements ProtocolMessageEnum

 An indicator of the behavior of a given field (for example, that a field
 is required in requests, or given as output but ignored as input).
 This **does not** change the behavior in protocol buffers itself; it only
 denotes the behavior and may affect how API tooling handles the field.
 Note: This enum **may** receive new values in the future.
 

Protobuf enum google.api.FieldBehavior

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIELD_BEHAVIOR_UNSPECIFIED Conventional default for enums.
IMMUTABLE Denotes a field as immutable.
INPUT_ONLY Denotes a field as input only.
OPTIONAL Specifically denotes a field as optional.
OUTPUT_ONLY Denotes a field as output only.
REQUIRED Denotes a field as required.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_BEHAVIOR_UNSPECIFIED_VALUE Conventional default for enums.
static int	IMMUTABLE_VALUE Denotes a field as immutable.
static int	INPUT_ONLY_VALUE Denotes a field as input only.
static int	OPTIONAL_VALUE Specifically denotes a field as optional.
static int	OUTPUT_ONLY_VALUE Denotes a field as output only.
static int	REQUIRED_VALUE Denotes a field as required.

Method Summary

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

FIELD_BEHAVIOR_UNSPECIFIED

public static final FieldBehavior FIELD_BEHAVIOR_UNSPECIFIED

 Conventional default for enums. Do not use this.
 

FIELD_BEHAVIOR_UNSPECIFIED = 0;

OPTIONAL

public static final FieldBehavior OPTIONAL

 Specifically denotes a field as optional.
 While all fields in protocol buffers are optional, this may be specified
 for emphasis if appropriate.
 

OPTIONAL = 1;

REQUIRED

public static final FieldBehavior REQUIRED

 Denotes a field as required.
 This indicates that the field **must** be provided as part of the request,
 and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
 

REQUIRED = 2;

OUTPUT_ONLY

public static final FieldBehavior OUTPUT_ONLY

 Denotes a field as output only.
 This indicates that the field is provided in responses, but including the
 field in a request does nothing (the server *must* ignore it and
 *must not* throw an error as a result of the field's presence).
 

OUTPUT_ONLY = 3;

INPUT_ONLY

public static final FieldBehavior INPUT_ONLY

 Denotes a field as input only.
 This indicates that the field is provided in requests, and the
 corresponding field is not included in output.
 

INPUT_ONLY = 4;

IMMUTABLE

public static final FieldBehavior IMMUTABLE

 Denotes a field as immutable.
 This indicates that the field may be set once in a request to create a
 resource, but may not be changed thereafter.
 

IMMUTABLE = 5;

UNRECOGNIZED

public static final FieldBehavior UNRECOGNIZED

Field Detail

FIELD_BEHAVIOR_UNSPECIFIED_VALUE

public static final int FIELD_BEHAVIOR_UNSPECIFIED_VALUE

 Conventional default for enums. Do not use this.
 

FIELD_BEHAVIOR_UNSPECIFIED = 0;

See Also:

Constant Field Values

OPTIONAL_VALUE

public static final int OPTIONAL_VALUE

 Specifically denotes a field as optional.
 While all fields in protocol buffers are optional, this may be specified
 for emphasis if appropriate.
 

OPTIONAL = 1;

See Also:

Constant Field Values

REQUIRED_VALUE

public static final int REQUIRED_VALUE

 Denotes a field as required.
 This indicates that the field **must** be provided as part of the request,
 and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
 

REQUIRED = 2;

See Also:

Constant Field Values

OUTPUT_ONLY_VALUE

public static final int OUTPUT_ONLY_VALUE

 Denotes a field as output only.
 This indicates that the field is provided in responses, but including the
 field in a request does nothing (the server *must* ignore it and
 *must not* throw an error as a result of the field's presence).
 

OUTPUT_ONLY = 3;

See Also:

Constant Field Values

INPUT_ONLY_VALUE

public static final int INPUT_ONLY_VALUE

 Denotes a field as input only.
 This indicates that the field is provided in requests, and the
 corresponding field is not included in output.
 

INPUT_ONLY = 4;

See Also:

Constant Field Values

IMMUTABLE_VALUE

public static final int IMMUTABLE_VALUE

 Denotes a field as immutable.
 This indicates that the field may be set once in a request to create a
 resource, but may not be changed thereafter.
 

IMMUTABLE = 5;

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static FieldBehavior valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface Internal.EnumLite

Specified by:

getNumber in interface ProtocolMessageEnum

valueOf

@Deprecated
public static FieldBehavior valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static FieldBehavior forNumber(int value)

internalGetValueMap

public static Internal.EnumLiteMap<FieldBehavior> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static FieldBehavior valueOf(Descriptors.EnumValueDescriptor desc)