Class: Google::Api::FieldBehavior

Inherits:

Object

• Object
• Google::Api::FieldBehavior

Extended by:

Protobug::Enum

Defined in:

lib/google/api/field_behavior_pb.rb

Overview

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.

Constant Summary

FIELD_BEHAVIOR_UNSPECIFIED =

Conventional default for enums. Do not use this.

new("FIELD_BEHAVIOR_UNSPECIFIED", 0).freeze

OPTIONAL =

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

new("OPTIONAL", 1).freeze

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`).

new("REQUIRED", 2).freeze

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).

new("OUTPUT_ONLY", 3).freeze

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.

new("INPUT_ONLY", 4).freeze

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.

new("IMMUTABLE", 5).freeze

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.

new("UNORDERED_LIST", 6).freeze

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.

new("NON_EMPTY_DEFAULT", 7).freeze

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.

new("IDENTIFIER", 8).freeze