Class: Google::Apis::ComputeAlpha::Any
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Any
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
Any
contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of
utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) ...
Example 2: Pack and unpack a message in Java.
Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) foo = any.
unpack(Foo.class);
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.
Unpack(foo) ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo...
any, err := anypb.New(foo) if err != nil ...
... foo :=
&pb.Foo`if err := any.UnmarshalTo(foo); err != nil
...
The pack methods provided by protobuf library will by default use 'type.
googleapis.com/full.type.name' as the type URL and the unpack methods only use
the fully qualified type name after the last '/' in the type URL, for example "
foo.bar.com/x/y.z" will yield type name "y.z".
JSON ==== The JSON representation of an
Anyvalue uses the regular
representation of the deserialized, embedded message, with an additional field
@typewhich contains the type URL. Example:
package google.profile; message Person
string first_name = 1; string
last_name = 2;
"@type": "type.googleapis.com/google.profile.Person", "firstName": , "
lastName":
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
value
which holds the custom JSON in addition to the
@typefield. Example (for
message [google.protobuf.Duration][]):
"@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" `
Instance Attribute Summary collapse
-
#type_url ⇒ String
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message.
-
#value ⇒ String
Must be a valid serialized protocol buffer of the above specified type.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Any
constructor
A new instance of Any.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Any
Returns a new instance of Any.
1373 1374 1375 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1373 def initialize(**args) update!(**args) end |
Instance Attribute Details
#type_url ⇒ String
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least one "/" character.
The last segment of the URL's path must represent the fully qualified name of
the type (as in path/google.protobuf.Duration
). The name should be in a
canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the scheme
http
, https
, or no scheme, one can optionally set up a type server that
maps type URLs to message definitions as follows:
- If no scheme is provided,
https
is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other thanhttp
,https
(or the empty scheme) might be used with implementation specific semantics. Corresponds to the JSON propertytypeUrl
1365 1366 1367 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1365 def type_url @type_url end |
#value ⇒ String
Must be a valid serialized protocol buffer of the above specified type.
Corresponds to the JSON property value
NOTE: Values are automatically base64 encoded/decoded in the client library.
1371 1372 1373 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1371 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1378 1379 1380 1381 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1378 def update!(**args) @type_url = args[:type_url] if args.key?(:type_url) @value = args[:value] if args.key?(:value) end |