Reference documentation and code samples for the Service Usage V1 API class Google::Protobuf::Option.
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#name
def name() -> ::String
Returns
-
(::String) — The option's name. For protobuf built-in options (options defined in
descriptor.proto), this is the short name. For example,
"map_entry". For custom options, it should be the fully-qualified name. For example,"google.api.http".
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — The option's name. For protobuf built-in options (options defined in
descriptor.proto), this is the short name. For example,
"map_entry". For custom options, it should be the fully-qualified name. For example,"google.api.http".
Returns
-
(::String) — The option's name. For protobuf built-in options (options defined in
descriptor.proto), this is the short name. For example,
"map_entry". For custom options, it should be the fully-qualified name. For example,"google.api.http".
#value
def value() -> ::Google::Protobuf::Any
Returns
- (::Google::Protobuf::Any) — The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
#value=
def value=(value) -> ::Google::Protobuf::Any
Parameter
- value (::Google::Protobuf::Any) — The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
Returns
- (::Google::Protobuf::Any) — The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.