Documentation

FieldBehavior
in package

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 type google.api.FieldBehavior

Table of Contents

Constants

FIELD_BEHAVIOR_UNSPECIFIED  = 0
Conventional default for enums. Do not use this.
IMMUTABLE  = 5
Denotes a field as immutable.
INPUT_ONLY  = 4
Denotes a field as input only.
NON_EMPTY_DEFAULT  = 7
Denotes that this field returns a non-empty default value if not set.
OPTIONAL  = 1
Specifically denotes a field as optional.
OUTPUT_ONLY  = 3
Denotes a field as output only.
REQUIRED  = 2
Denotes a field as required.
UNORDERED_LIST  = 6
Denotes that a (repeated) field is an unordered list.

Properties

$valueToName  : mixed

Methods

name()  : mixed
value()  : mixed

Constants

FIELD_BEHAVIOR_UNSPECIFIED

Conventional default for enums. Do not use this.

public mixed FIELD_BEHAVIOR_UNSPECIFIED = 0

Generated from protobuf enum FIELD_BEHAVIOR_UNSPECIFIED = 0;

IMMUTABLE

Denotes a field as immutable.

public mixed IMMUTABLE = 5

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

Generated from protobuf enum IMMUTABLE = 5;

INPUT_ONLY

Denotes a field as input only.

public mixed INPUT_ONLY = 4

This indicates that the field is provided in requests, and the corresponding field is not included in output.

Generated from protobuf enum INPUT_ONLY = 4;

NON_EMPTY_DEFAULT

Denotes that this field returns a non-empty default value if not set.

public mixed NON_EMPTY_DEFAULT = 7

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.

Generated from protobuf enum NON_EMPTY_DEFAULT = 7;

OPTIONAL

Specifically denotes a field as optional.

public mixed OPTIONAL = 1

While all fields in protocol buffers are optional, this may be specified for emphasis if appropriate.

Generated from protobuf enum OPTIONAL = 1;

OUTPUT_ONLY

Denotes a field as output only.

public mixed OUTPUT_ONLY = 3

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

Generated from protobuf enum OUTPUT_ONLY = 3;

REQUIRED

Denotes a field as required.

public mixed REQUIRED = 2

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

Generated from protobuf enum REQUIRED = 2;

UNORDERED_LIST

Denotes that a (repeated) field is an unordered list.

public mixed UNORDERED_LIST = 6

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.

Generated from protobuf enum UNORDERED_LIST = 6;

Properties

$valueToName

private static mixed $valueToName = [self::FIELD_BEHAVIOR_UNSPECIFIED => 'FIELD_BEHAVIOR_UNSPECIFIED', self::OPTIONAL => 'OPTIONAL', self::REQUIRED => 'REQUIRED', self::OUTPUT_ONLY => 'OUTPUT_ONLY', self::INPUT_ONLY => 'INPUT_ONLY', self::IMMUTABLE => 'IMMUTABLE', self::UNORDERED_LIST => 'UNORDERED_LIST', self::NON_EMPTY_DEFAULT => 'NON_EMPTY_DEFAULT']

Methods

name()

public static name(mixed $value) : mixed
Parameters
$value : mixed

value()

public static value(mixed $name) : mixed
Parameters
$name : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results