Class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteexecutionV1testActionResult

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

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

Returns a new instance of GoogleDevtoolsRemoteexecutionV1testActionResult



2142
2143
2144
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 2142

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

Instance Attribute Details

#exit_code ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1984
1985
1986
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 1984

def exit_code
  @exit_code
end

#output_directories ⇒ Array<Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteexecutionV1testOutputDirectory>

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
`
]
`
`

Corresponds to the JSON property outputDirectories

Returns:



2045
2046
2047
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 2045

def output_directories
  @output_directories
end

#output_files ⇒ Array<Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteexecutionV1testOutputFile>

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 in the output list. If the action does not produce the requested output, or produces a directory where a regular file is expected or vice versa, 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

Returns:



2056
2057
2058
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 2056

def output_files
  @output_files
end

#stderr_digest ⇒ Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteexecutionV1testDigest

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

Returns:



2087
2088
2089
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 2087

def stderr_digest
  @stderr_digest
end

#stderr_raw ⇒ String

The standard error buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in stderr_digest that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. Corresponds to the JSON property stderrRaw NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2098
2099
2100
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 2098

def stderr_raw
  @stderr_raw
end

#stdout_digest ⇒ Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteexecutionV1testDigest

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

Returns:



2129
2130
2131
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 2129

def stdout_digest
  @stdout_digest
end

#stdout_raw ⇒ String

The standard output buffer of the action. The server will determine, based on the size of the buffer, whether to return it in raw form or to return a digest in stdout_digest that points to the buffer. If neither is set, then the buffer is empty. The client SHOULD NOT assume it will get one of the raw buffer or a digest on any given request and should be prepared to handle either. Corresponds to the JSON property stdoutRaw NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2140
2141
2142
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 2140

def stdout_raw
  @stdout_raw
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2147
2148
2149
2150
2151
2152
2153
2154
2155
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 2147

def update!(**args)
  @exit_code = args[:exit_code] if args.key?(:exit_code)
  @output_directories = args[:output_directories] if args.key?(:output_directories)
  @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