Batch V1 API - Class Google::Api::TypeReference (v0.18.2)

Reference documentation and code samples for the Batch V1 API class Google::Api::TypeReference.

A reference to a message type, for use in FieldInfo.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#type_name

def type_name() -> ::String
Returns
  • (::String) — The name of the type that the annotated, generic field may represent. If the type is in the same protobuf package, the value can be the simple message name e.g., "MyMessage". Otherwise, the value must be the fully-qualified message name e.g., "google.library.v1.Book".

    If the type(s) are unknown to the service (e.g. the field accepts generic user input), use the wildcard "*" to denote this behavior.

    See AIP-202 for more details.

#type_name=

def type_name=(value) -> ::String
Parameter
  • value (::String) — The name of the type that the annotated, generic field may represent. If the type is in the same protobuf package, the value can be the simple message name e.g., "MyMessage". Otherwise, the value must be the fully-qualified message name e.g., "google.library.v1.Book".

    If the type(s) are unknown to the service (e.g. the field accepts generic user input), use the wildcard "*" to denote this behavior.

    See AIP-202 for more details.

Returns
  • (::String) — The name of the type that the annotated, generic field may represent. If the type is in the same protobuf package, the value can be the simple message name e.g., "MyMessage". Otherwise, the value must be the fully-qualified message name e.g., "google.library.v1.Book".

    If the type(s) are unknown to the service (e.g. the field accepts generic user input), use the wildcard "*" to denote this behavior.

    See AIP-202 for more details.