Class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteexecutionV1testDigest
- Inherits:
-
Object
- Object
- Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteexecutionV1testDigest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/remotebuildexecution_v1alpha/classes.rb,
generated/google/apis/remotebuildexecution_v1alpha/representations.rb,
generated/google/apis/remotebuildexecution_v1alpha/representations.rb
Overview
A content digest. A digest for a given blob consists of the size of the blob
and its hash. The hash algorithm to use is defined by the server, but servers
SHOULD use SHA-256.
The size is considered to be an integral part of the digest and cannot be
separated. That is, even if the hash
field is correctly specified but
size_bytes
is not, the server MUST reject the request.
The reason for including the size in the digest is as follows: in a great
many cases, the server needs to know the size of the blob it is about to work
with prior to starting an operation with it, such as flattening Merkle tree
structures or streaming it to a worker. Technically, the server could
implement a separate metadata store, but this results in a significantly more
complicated implementation as opposed to having the client specify the size
up-front (or storing the size along with the digest in every message where
digests are embedded). This does mean that the API leaks some implementation
details of (what we consider to be) a reasonable server implementation, but
we consider this to be a worthwhile tradeoff.
When a Digest
is used to refer to a proto message, it always refers to the
message in binary encoded form. To ensure consistent hashing, clients and
servers MUST ensure that they serialize messages according to the following
rules, even if there are alternate valid encodings for the same message.
- Fields are serialized in tag order.
- There are no unknown fields.
- There are no duplicate fields.
- Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields.
Instance Attribute Summary collapse
-
#hash_prop ⇒ String
The hash.
-
#size_bytes ⇒ Fixnum
The size of the blob, in bytes.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleDevtoolsRemoteexecutionV1testDigest
constructor
A new instance of GoogleDevtoolsRemoteexecutionV1testDigest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleDevtoolsRemoteexecutionV1testDigest
Returns a new instance of GoogleDevtoolsRemoteexecutionV1testDigest
2243 2244 2245 |
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2243 def initialize(**args) update!(**args) end |
Instance Attribute Details
#hash_prop ⇒ String
The hash. In the case of SHA-256, it will always be a lowercase hex string
exactly 64 characters long.
Corresponds to the JSON property hash
2236 2237 2238 |
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2236 def hash_prop @hash_prop end |
#size_bytes ⇒ Fixnum
The size of the blob, in bytes.
Corresponds to the JSON property sizeBytes
2241 2242 2243 |
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2241 def size_bytes @size_bytes end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2248 2249 2250 2251 |
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2248 def update!(**args) @hash_prop = args[:hash_prop] if args.key?(:hash_prop) @size_bytes = args[:size_bytes] if args.key?(:size_bytes) end |