Class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2ActionResult
- Inherits:
-
Object
- Object
- Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2ActionResult
- 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
An ActionResult represents the result of an Action being run.
Instance Attribute Summary collapse
-
#execution_metadata ⇒ Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2ExecutedActionMetadata
ExecutedActionMetadata contains details about a completed execution.
-
#exit_code ⇒ Fixnum
The exit code of the command.
-
#output_directories ⇒ Array<Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputDirectory>
The output directories of the action.
-
#output_directory_symlinks ⇒ Array<Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputSymlink>
The output directories of the action that are symbolic links to other directories.
-
#output_file_symlinks ⇒ Array<Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputSymlink>
The output files of the action that are symbolic links to other files.
-
#output_files ⇒ Array<Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputFile>
The output files of the action.
-
#stderr_digest ⇒ Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest
A content digest.
-
#stderr_raw ⇒ String
The standard error buffer of the action.
-
#stdout_digest ⇒ Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest
A content digest.
-
#stdout_raw ⇒ String
The standard output buffer of the action.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BuildBazelRemoteExecutionV2ActionResult
constructor
A new instance of BuildBazelRemoteExecutionV2ActionResult.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ BuildBazelRemoteExecutionV2ActionResult
Returns a new instance of BuildBazelRemoteExecutionV2ActionResult.
359 360 361 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 359 def initialize(**args) update!(**args) end |
Instance Attribute Details
#execution_metadata ⇒ Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2ExecutedActionMetadata
ExecutedActionMetadata contains details about a completed execution.
Corresponds to the JSON property executionMetadata
156 157 158 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 156 def @execution_metadata end |
#exit_code ⇒ Fixnum
The exit code of the command.
Corresponds to the JSON property exitCode
161 162 163 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 161 def exit_code @exit_code end |
#output_directories ⇒ Array<Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputDirectory>
The output directories of the action. For each output directory requested
in the output_directories
field of the Action, if the corresponding
directory existed after the action completed, a single entry will be
present in the output list, which will contain the digest of a
Tree message containing the
directory tree, and the path equal exactly to the corresponding Action
output_directories member.
As an example, suppose the Action had an output directory a/b/dir
and the
execution produced the following contents in a/b/dir
: a file named bar
and a directory named foo
with an executable file named baz
. Then,
output_directory will contain (hashes shortened for readability):
// OutputDirectory proto:
`
path: "a/b/dir"
tree_digest: `
hash: "4a73bc9d03...",
size: 55
`
`
// Tree proto with hash "4a73bc9d03..." and size 55:
`
root: `
files: [
`
name: "bar",
digest: `
hash: "4a73bc9d03...",
size: 65534
`
`
],
directories: [
`
name: "foo",
digest: `
hash: "4cf2eda940...",
size: 43
`
`
]
`
children : `
// (Directory proto with hash "4cf2eda940..." and size 43)
files: [
`
name: "baz",
digest: `
hash: "b2c941073e...",
size: 1294,
`,
is_executable: true
`
]
`
`
If an output of the same name was found, but was not a directory, the
server will return a FAILED_PRECONDITION.
Corresponds to the JSON property outputDirectories
224 225 226 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 224 def output_directories @output_directories end |
#output_directory_symlinks ⇒ Array<Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputSymlink>
The output directories of the action that are symbolic links to other
directories. Those may be links to other output directories, or input
directories, or even absolute paths outside of the working directory,
if the server supports
SymlinkAbsolutePathStrategy.ALLOWED.
For each output directory requested in the output_directories
field of
the Action, if the directory existed after the action completed, a
single entry will be present either in this field, or in the
output_directories
field, if the directory was not a symbolic link.
If an output of the same name was found, but was a symbolic link to a file
instead of a directory, the server will return a FAILED_PRECONDITION.
If the action does not produce the requested output, then that output
will be omitted from the list. The server is free to arrange the output
list as desired; clients MUST NOT assume that the output list is sorted.
Corresponds to the JSON property outputDirectorySymlinks
242 243 244 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 242 def output_directory_symlinks @output_directory_symlinks end |
#output_file_symlinks ⇒ Array<Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputSymlink>
The output files of the action that are symbolic links to other files. Those
may be links to other output files, or input files, or even absolute paths
outside of the working directory, if the server supports
SymlinkAbsolutePathStrategy.ALLOWED.
For each output file requested in the output_files
field of the Action,
if the corresponding file existed after
the action completed, a single entry will be present either in this field,
or in the output_files
field, if the file was not a symbolic link.
If an output symbolic link of the same name was found, but its target
type was not a regular file, the server will return a FAILED_PRECONDITION.
If the action does not produce the requested output, then that output
will be omitted from the list. The server is free to arrange the output
list as desired; clients MUST NOT assume that the output list is sorted.
Corresponds to the JSON property outputFileSymlinks
259 260 261 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 259 def output_file_symlinks @output_file_symlinks end |
#output_files ⇒ Array<Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputFile>
The output files of the action. For each output file requested in the
output_files
field of the Action, if the corresponding file existed after
the action completed, a single entry will be present either in this field,
or the output_file_symlinks
field if the file was a symbolic link to
another file.
If an output of the same name was found, but was a directory rather
than a regular file, the server will return a FAILED_PRECONDITION.
If the action does not produce the requested output, then that output
will be omitted from the list. The server is free to arrange the output
list as desired; clients MUST NOT assume that the output list is sorted.
Corresponds to the JSON property outputFiles
273 274 275 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 273 def output_files @output_files end |
#stderr_digest ⇒ Google::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, 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.
Corresponds to the JSON property
stderrDigest
304 305 306 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 304 def stderr_digest @stderr_digest end |
#stderr_raw ⇒ String
The standard error buffer of the action. The server SHOULD NOT inline
stderr unless requested by the client in the
GetActionResultRequest
message. The server MAY omit inlining, even if requested, and MUST do so if
inlining
would cause the response to exceed message size limits.
Corresponds to the JSON property stderrRaw
NOTE: Values are automatically base64 encoded/decoded in the client library.
315 316 317 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 315 def stderr_raw @stderr_raw end |
#stdout_digest ⇒ Google::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, 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.
Corresponds to the JSON property
stdoutDigest
346 347 348 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 346 def stdout_digest @stdout_digest end |
#stdout_raw ⇒ String
The standard output buffer of the action. The server SHOULD NOT inline
stdout unless requested by the client in the
GetActionResultRequest
message. The server MAY omit inlining, even if requested, and MUST do so if
inlining
would cause the response to exceed message size limits.
Corresponds to the JSON property stdoutRaw
NOTE: Values are automatically base64 encoded/decoded in the client library.
357 358 359 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 357 def stdout_raw @stdout_raw end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 364 def update!(**args) @execution_metadata = args[:execution_metadata] if args.key?(:execution_metadata) @exit_code = args[:exit_code] if args.key?(:exit_code) @output_directories = args[:output_directories] if args.key?(:output_directories) @output_directory_symlinks = args[:output_directory_symlinks] if args.key?(:output_directory_symlinks) @output_file_symlinks = args[:output_file_symlinks] if args.key?(:output_file_symlinks) @output_files = args[:output_files] if args.key?(:output_files) @stderr_digest = args[:stderr_digest] if args.key?(:stderr_digest) @stderr_raw = args[:stderr_raw] if args.key?(:stderr_raw) @stdout_digest = args[:stdout_digest] if args.key?(:stdout_digest) @stdout_raw = args[:stdout_raw] if args.key?(:stdout_raw) end |