Reference documentation and code samples for the Live Stream V1 API class Google::Api::FieldInfo.
Rich semantic information of an API field beyond basic typing.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#format
def format() -> ::Google::Api::FieldInfo::Format
Returns
- (::Google::Api::FieldInfo::Format) — The standard format of a field value. This does not explicitly configure any API consumer, just documents the API's format for the field it is applied to.
#format=
def format=(value) -> ::Google::Api::FieldInfo::Format
Parameter
- value (::Google::Api::FieldInfo::Format) — The standard format of a field value. This does not explicitly configure any API consumer, just documents the API's format for the field it is applied to.
Returns
- (::Google::Api::FieldInfo::Format) — The standard format of a field value. This does not explicitly configure any API consumer, just documents the API's format for the field it is applied to.
#referenced_types
def referenced_types() -> ::Array<::Google::Api::TypeReference>
Returns
-
(::Array<::Google::Api::TypeReference>) — The type(s) that the annotated, generic field may represent.
Currently, this must only be used on fields of type
google.protobuf.Any. Supporting other generic types may be considered in the future.
#referenced_types=
def referenced_types=(value) -> ::Array<::Google::Api::TypeReference>
Parameter
-
value (::Array<::Google::Api::TypeReference>) — The type(s) that the annotated, generic field may represent.
Currently, this must only be used on fields of type
google.protobuf.Any. Supporting other generic types may be considered in the future.
Returns
-
(::Array<::Google::Api::TypeReference>) — The type(s) that the annotated, generic field may represent.
Currently, this must only be used on fields of type
google.protobuf.Any. Supporting other generic types may be considered in the future.