Class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2ExecuteResponse

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

The response message for Execution.Execute, which will be contained in the response 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) ⇒ BuildBazelRemoteExecutionV2ExecuteResponse

Returns a new instance of BuildBazelRemoteExecutionV2ExecuteResponse



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

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

Instance Attribute Details

#cached_result ⇒ Boolean Also known as: cached_result?

True if the result was served from cache, false if it was executed. Corresponds to the JSON property cachedResult

Returns:

  • (Boolean) 


776
777
778
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 776

def cached_result
  @cached_result
end

#message ⇒ String

Freeform informational message with details on the execution of the action that may be displayed to the user upon failure or when requested explicitly. Corresponds to the JSON property message

Returns:

  • (String) 


783
784
785
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 783

def message
  @message
end

#result ⇒ Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2ActionResult

An ActionResult represents the result of an Action being run. Corresponds to the JSON property result

Returns:



789
790
791
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 789

def result
  @result
end

#server_logs ⇒ Hash<String,Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2LogFile>

An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user. Corresponds to the JSON property serverLogs

Returns:



800
801
802
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 800

def server_logs
  @server_logs
end

#status ⇒ Google::Apis::RemotebuildexecutionV1::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:



843
844
845
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 843

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



850
851
852
853
854
855
856
 
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 850

def update!(**args)
  @cached_result = args[:cached_result] if args.key?(:cached_result)
  @message = args[:message] if args.key?(:message)
  @result = args[:result] if args.key?(:result)
  @server_logs = args[:server_logs] if args.key?(:server_logs)
  @status = args[:status] if args.key?(:status)
end