http4s-grpc-google-common-protos/com.google/com.google.api/com.google.api.field_behavior/FieldBehavior

FieldBehavior

com.google.api.field_behavior.FieldBehavior

See theFieldBehavior companion class

object FieldBehavior extends GeneratedEnumCompanion[FieldBehavior]

Attributes

Companion: class
Source: FieldBehavior.scala
Graph
Supertypes: trait Sum

trait Mirror

trait GeneratedEnumCompanion[FieldBehavior]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: FieldBehavior.type

Members list

Type members

Classlikes

Conventional default for enums.

Conventional default for enums. Do not use this.

Attributes

Source: FieldBehavior.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: FIELD_BEHAVIOR_UNSPECIFIED.type

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

Attributes

Source: FieldBehavior.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: IDENTIFIER.type

Denotes a field as 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.

Attributes

Source: FieldBehavior.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: IMMUTABLE.type

Denotes a field as 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.

Attributes

Source: FieldBehavior.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: INPUT_ONLY.type

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

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.

Attributes

Source: FieldBehavior.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: NON_EMPTY_DEFAULT.type

Specifically denotes a field as optional.

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

Attributes

Source: FieldBehavior.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: OPTIONAL.type

Denotes a field as 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).

Attributes

Source: FieldBehavior.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: OUTPUT_ONLY.type

Denotes a field as 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).

Attributes

Source: FieldBehavior.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: REQUIRED.type

Attributes

Source: FieldBehavior.scala
Supertypes: class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: object FIELD_BEHAVIOR_UNSPECIFIED.type

object IDENTIFIER.type

object IMMUTABLE.type

object INPUT_ONLY.type

object NON_EMPTY_DEFAULT.type

object OPTIONAL.type

object OUTPUT_ONLY.type

object REQUIRED.type

object UNORDERED_LIST.type
Show all

Denotes that a (repeated) field is an 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.

Attributes

Source: FieldBehavior.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Recognized

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: UNORDERED_LIST.type

Attributes

Source: FieldBehavior.scala
Supertypes: trait UnrecognizedEnum

class FieldBehavior

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Inherited types

The names of the product elements

Attributes

Inherited from:: Mirror
Source: Mirror.scala

The name of the type

Attributes

Inherited from:: Mirror
Source: Mirror.scala

Attributes

Inherited from:: GeneratedEnumCompanion
Source: GeneratedMessageCompanion.scala

Value members

Concrete methods

Attributes

Source: FieldBehavior.scala

Returns the Java descriptors for this enum.

Returns the Java descriptors for this enum. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.