Class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteworkersV1test2CommandResult

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

All information about the execution of a command, suitable for providing as the Bots interface's Lease.result field.

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

Returns a new instance of GoogleDevtoolsRemoteworkersV1test2CommandResult



3200
3201
3202
 
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 3200

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

Instance Attribute Details

#duration ⇒ String

The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time. Corresponds to the JSON property duration

Returns:

  • (String) 


3121
3122
3123
 
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 3121

def duration
  @duration
end

#exit_code ⇒ Fixnum

The exit code of the process. An exit code of "0" should only be trusted if status has a code of OK (otherwise it may simply be unset). Corresponds to the JSON property exitCode

Returns:

  • (Fixnum) 


3127
3128
3129
 
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 3127

def exit_code
  @exit_code
end

#metadata ⇒ Array<Hash<String,Object>>

Implementation-dependent metadata about the task. Both servers and bots may define messages which can be encoded here; bots are free to provide metadata in multiple formats, and servers are free to choose one or more of the values to process and ignore others. In particular, it is not considered an error for the bot to provide the server with a field that it doesn't know about. Corresponds to the JSON property metadata

Returns:

  • (Array<Hash<String,Object>>) 


3137
3138
3139
 
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 3137

def metadata
  @metadata
end

#outputs ⇒ Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteworkersV1test2Digest

The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a "digest." The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's "ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message. Corresponds to the JSON property outputs

Returns:



3149
3150
3151
 
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 3149

def outputs
  @outputs
end

#overhead ⇒ String

The amount of time not spent executing the command (ie uploading/downloading files). Corresponds to the JSON property overhead

Returns:

  • (String) 


3155
3156
3157
 
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 3155

def overhead
  @overhead
end

#status ⇒ Google::Apis::RemotebuildexecutionV1alpha::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be:

  • Simple to use and understand for most users
  • Flexible enough to meet unexpected needs # Overview The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions. # Language mapping The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include:
  • Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
  • Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
  • Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
  • Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
  • Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. Corresponds to the JSON property status

Returns:



3198
3199
3200
 
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 3198

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3205
3206
3207
3208
3209
3210
3211
3212
 
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 3205

def update!(**args)
  @duration = args[:duration] if args.key?(:duration)
  @exit_code = args[:exit_code] if args.key?(:exit_code)
  @metadata = args[:metadata] if args.key?(:metadata)
  @outputs = args[:outputs] if args.key?(:outputs)
  @overhead = args[:overhead] if args.key?(:overhead)
  @status = args[:status] if args.key?(:status)
end