Class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2ExecuteOperationMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/remotebuildexecution_v1/classes.rb,
generated/google/apis/remotebuildexecution_v1/representations.rb,
generated/google/apis/remotebuildexecution_v1/representations.rb

Overview

Metadata about an ongoing execution, which will be contained in the metadata field of the Operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BuildBazelRemoteExecutionV2ExecuteOperationMetadata

Returns a new instance of BuildBazelRemoteExecutionV2ExecuteOperationMetadata.



839
840
841
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 839

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#action_digestGoogle::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest

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. 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. Corresponds to the JSON property actionDigest


818
819
820
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 818

def action_digest
  @action_digest
end

#stageString

The current stage of execution. Corresponds to the JSON property stage

Returns:

  • (String)


823
824
825
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 823

def stage
  @stage
end

#stderr_stream_nameString

If set, the client can use this name with ByteStream.Read to stream the standard error. Corresponds to the JSON property stderrStreamName

Returns:

  • (String)


830
831
832
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 830

def stderr_stream_name
  @stderr_stream_name
end

#stdout_stream_nameString

If set, the client can use this name with ByteStream.Read to stream the standard output. Corresponds to the JSON property stdoutStreamName

Returns:

  • (String)


837
838
839
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 837

def stdout_stream_name
  @stdout_stream_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



844
845
846
847
848
849
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 844

def update!(**args)
  @action_digest = args[:action_digest] if args.key?(:action_digest)
  @stage = args[:stage] if args.key?(:stage)
  @stderr_stream_name = args[:stderr_stream_name] if args.key?(:stderr_stream_name)
  @stdout_stream_name = args[:stdout_stream_name] if args.key?(:stdout_stream_name)
end