Package com.google.api
Enum Class FieldBehavior
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite
,Serializable
,Comparable<FieldBehavior>
,Constable
public enum FieldBehavior
extends Enum<FieldBehavior>
implements com.google.protobuf.Internal.EnumLite
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
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionConventional default for enums.Denotes that the field in a resource (a message annotated with google.api.resource) is used in the resource name to uniquely identify the resource.Denotes a field as immutable.Denotes a field as input only.Denotes that this field returns a non-empty default value if not set.Specifically denotes a field as optional.Denotes a field as output only.Denotes a field as required.Denotes that a (repeated) field is an unordered list. -
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Conventional default for enums.static final int
Denotes that the field in a resource (a message annotated with google.api.resource) is used in the resource name to uniquely identify the resource.static final int
Denotes a field as immutable.static final int
Denotes a field as input only.static final int
Denotes that this field returns a non-empty default value if not set.static final int
Specifically denotes a field as optional.static final int
Denotes a field as output only.static final int
Denotes a field as required.static final int
Denotes that a (repeated) field is an unordered list. -
Method Summary
Modifier and TypeMethodDescriptionstatic FieldBehavior
forNumber
(int value) final int
static com.google.protobuf.Internal.EnumLiteMap<FieldBehavior>
static com.google.protobuf.Internal.EnumVerifier
static FieldBehavior
valueOf
(int value) Deprecated.static FieldBehavior
Returns the enum constant of this class with the specified name.static FieldBehavior[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FIELD_BEHAVIOR_UNSPECIFIED
Conventional default for enums. Do not use this.
FIELD_BEHAVIOR_UNSPECIFIED = 0;
-
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
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
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
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
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;
-
UNORDERED_LIST
Denotes that a (repeated) field is an unordered list. This indicates that the service may provide the elements of the list in any arbitrary order, rather than the order the user originally provided. Additionally, the list's order may or may not be stable.
UNORDERED_LIST = 6;
-
NON_EMPTY_DEFAULT
Denotes that this field returns a non-empty default value if not set. This indicates that if the user provides the empty value in a request, a non-empty value will be returned. The user will not be aware of what non-empty value to expect.
NON_EMPTY_DEFAULT = 7;
-
IDENTIFIER
Denotes that the field in a resource (a message annotated with google.api.resource) is used in the resource name to uniquely identify the resource. For AIP-compliant APIs, this should only be applied to the `name` field on the resource. This behavior should not be applied to references to other resources within the message. The identifier field of resources often have different field behavior depending on the request it is embedded in (e.g. for Create methods name is optional and unused, while for Update methods it is required). Instead of method-specific annotations, only `IDENTIFIER` is required.
IDENTIFIER = 8;
-
UNRECOGNIZED
-
-
Field Details
-
FIELD_BEHAVIOR_UNSPECIFIED_VALUE
public static final int FIELD_BEHAVIOR_UNSPECIFIED_VALUEConventional default for enums. Do not use this.
FIELD_BEHAVIOR_UNSPECIFIED = 0;
- See Also:
-
OPTIONAL_VALUE
public static final int OPTIONAL_VALUESpecifically 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:
-
REQUIRED_VALUE
public static final int REQUIRED_VALUEDenotes 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:
-
OUTPUT_ONLY_VALUE
public static final int OUTPUT_ONLY_VALUEDenotes 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:
-
INPUT_ONLY_VALUE
public static final int INPUT_ONLY_VALUEDenotes 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:
-
IMMUTABLE_VALUE
public static final int IMMUTABLE_VALUEDenotes 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:
-
UNORDERED_LIST_VALUE
public static final int UNORDERED_LIST_VALUEDenotes that a (repeated) field is an unordered list. This indicates that the service may provide the elements of the list in any arbitrary order, rather than the order the user originally provided. Additionally, the list's order may or may not be stable.
UNORDERED_LIST = 6;
- See Also:
-
NON_EMPTY_DEFAULT_VALUE
public static final int NON_EMPTY_DEFAULT_VALUEDenotes that this field returns a non-empty default value if not set. This indicates that if the user provides the empty value in a request, a non-empty value will be returned. The user will not be aware of what non-empty value to expect.
NON_EMPTY_DEFAULT = 7;
- See Also:
-
IDENTIFIER_VALUE
public static final int IDENTIFIER_VALUEDenotes that the field in a resource (a message annotated with google.api.resource) is used in the resource name to uniquely identify the resource. For AIP-compliant APIs, this should only be applied to the `name` field on the resource. This behavior should not be applied to references to other resources within the message. The identifier field of resources often have different field behavior depending on the request it is embedded in (e.g. for Create methods name is optional and unused, while for Update methods it is required). Instead of method-specific annotations, only `IDENTIFIER` is required.
IDENTIFIER = 8;
- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumber
in interfacecom.google.protobuf.Internal.EnumLite
-
valueOf
Deprecated.Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
forNumber
-
internalGetValueMap
-
internalGetVerifier
public static com.google.protobuf.Internal.EnumVerifier internalGetVerifier()
-