Class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2ActionResult

Inherits:
Object
  • Object
show all
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

An ActionResult represents the result of an Action being run.

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) ⇒ BuildBazelRemoteExecutionV2ActionResult

Returns a new instance of BuildBazelRemoteExecutionV2ActionResult.



390
391
392
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 390

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

Instance Attribute Details

#execution_metadataGoogle::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2ExecutedActionMetadata

ExecutedActionMetadata contains details about a completed execution. Corresponds to the JSON property executionMetadata



166
167
168
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 166

def 
  @execution_metadata
end

#exit_codeFixnum

The exit code of the command. Corresponds to the JSON property exitCode

Returns:

  • (Fixnum)


171
172
173
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 171

def exit_code
  @exit_code
end

#output_directoriesArray<Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2OutputDirectory>

The output directories of the action. For each output directory requested in the output_directories or output_paths 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 as listed in output_files of the Command was found in output_directories, but was not a directory, the server will return a FAILED_PRECONDITION. Corresponds to the JSON property outputDirectories



235
236
237
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 235

def output_directories
  @output_directories
end

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. DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API should still populate this field in addition to output_symlinks. Corresponds to the JSON property outputDirectorySymlinks



255
256
257
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 255

def output_directory_symlinks
  @output_directory_symlinks
end

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 or output_paths 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 as listed in output_files of the Command 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. DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API should still populate this field in addition to output_symlinks. Corresponds to the JSON property outputFileSymlinks



275
276
277
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 275

def output_file_symlinks
  @output_file_symlinks
end

#output_filesArray<Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2OutputFile>

The output files of the action. For each output file requested in the output_files or output_paths 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 (output_symlinks field after v2.1). If an output listed in output_files 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



289
290
291
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 289

def output_files
  @output_files
end

New in v2.1: this field will only be populated if the command output_paths field was used, and not the pre v2.1 output_files or output_directories fields. The output paths of the action that are symbolic links to other paths. Those may be links to other outputs, or inputs, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. A single entry for each output requested in output_paths field of the Action, if the corresponding path existed after the action completed and was a symbolic link. If the action does not produce a 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 outputSymlinks



306
307
308
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 306

def output_symlinks
  @output_symlinks
end

#stderr_digestGoogle::Apis::RemotebuildexecutionV1alpha::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 stderrDigest


336
337
338
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 336

def stderr_digest
  @stderr_digest
end

#stderr_rawString

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.

Returns:

  • (String)


347
348
349
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 347

def stderr_raw
  @stderr_raw
end

#stdout_digestGoogle::Apis::RemotebuildexecutionV1alpha::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 stdoutDigest


377
378
379
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 377

def stdout_digest
  @stdout_digest
end

#stdout_rawString

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.

Returns:

  • (String)


388
389
390
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 388

def stdout_raw
  @stdout_raw
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 395

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)
  @output_symlinks = args[:output_symlinks] if args.key?(:output_symlinks)
  @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