Class: Google::Apis::RemotebuildexecutionV2::RemoteBuildExecutionService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/remotebuildexecution_v2/service.rb

Overview

Remote Build Execution API

Supplies a Remote Execution API service for tools such as bazel.

Examples:

require 'google/apis/remotebuildexecution_v2'

Remotebuildexecution = Google::Apis::RemotebuildexecutionV2 # Alias the module
service = Remotebuildexecution::RemoteBuildExecutionService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeRemoteBuildExecutionService


45
46
47
48
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 45

def initialize
  super('https://remotebuildexecution.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#batch_blob_read(instance_name, build_bazel_remote_execution_v2_batch_read_blobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchReadBlobsResponse

Download many blobs at once. The server may enforce a limit of the combined total size of blobs to be downloaded using this API. This limit may be obtained using the Capabilities API. Requests exceeding the limit should either be split into smaller chunks or downloaded using the ByteStream API, as appropriate. This request is equivalent to calling a Bytestream Read request on each individual blob, in parallel. The requests may succeed or fail independently. Errors:

  • INVALID_ARGUMENT: The client attempted to read more than the server supported limit. Every error on individual read will be returned in the corresponding digest status.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


308
309
310
311
312
313
314
315
316
317
318
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 308

def batch_blob_read(instance_name, build_bazel_remote_execution_v2_batch_read_blobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+instanceName}/blobs:batchRead', options)
  command.request_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchReadBlobsRequest::Representation
  command.request_object = build_bazel_remote_execution_v2_batch_read_blobs_request_object
  command.response_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchReadBlobsResponse::Representation
  command.response_class = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchReadBlobsResponse
  command.params['instanceName'] = instance_name unless instance_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_blob_update(instance_name, build_bazel_remote_execution_v2_batch_update_blobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse

Upload many blobs at once. The server may enforce a limit of the combined total size of blobs to be uploaded using this API. This limit may be obtained using the Capabilities API. Requests exceeding the limit should either be split into smaller chunks or uploaded using the ByteStream API, as appropriate. This request is equivalent to calling a Bytestream Write request on each individual blob, in parallel. The requests may succeed or fail independently. Errors:

  • INVALID_ARGUMENT: The client attempted to upload more than the server supported limit. Individual requests may return the following errors, additionally:
  • RESOURCE_EXHAUSTED: There is insufficient disk quota to store the blob.
  • INVALID_ARGUMENT: The Digest does not match the provided data.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


362
363
364
365
366
367
368
369
370
371
372
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 362

def batch_blob_update(instance_name, build_bazel_remote_execution_v2_batch_update_blobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+instanceName}/blobs:batchUpdate', options)
  command.request_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchUpdateBlobsRequest::Representation
  command.request_object = build_bazel_remote_execution_v2_batch_update_blobs_request_object
  command.response_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse::Representation
  command.response_class = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse
  command.params['instanceName'] = instance_name unless instance_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_action(instance_name, build_bazel_remote_execution_v2_execute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV2::GoogleLongrunningOperation

Execute an action remotely. In order to execute an action, the client must first upload all of the inputs, the Command to run, and the Action into the ContentAddressableStorage. It then calls Execute with an action_digest referring to them. The server will run the action and eventually return the result. The input Action's fields MUST meet the various canonicalization requirements specified in the documentation for their types so that it has the same digest as other logically equivalent Actions. The server MAY enforce the requirements and return errors if a non-canonical input is received. It MAY also proceed without verifying some or all of the requirements, such as for performance reasons. If the server does not verify the requirement, then it will treat the Action as distinct from another logically equivalent action if they hash differently. Returns a stream of google.longrunning.Operation messages describing the resulting execution, with eventual response ExecuteResponse. The metadata on the operation is of type ExecuteOperationMetadata. If the client remains connected after the first response is returned after the server, then updates are streamed as if the client had called WaitExecution until the execution completes or the request reaches an error. The operation can also be queried using Operations API. The server NEED NOT implement other methods or functionality of the Operations API. Errors discovered during creation of the Operation will be reported as gRPC Status errors, while errors that occurred while running the action will be reported in the status field of the ExecuteResponse. The server MUST NOT set the error field of the Operation proto. The possible errors include:

  • INVALID_ARGUMENT: One or more arguments are invalid.
  • FAILED_PRECONDITION: One or more errors occurred in setting up the action requested, such as a missing input or command or no worker being available. The client may be able to fix the errors and retry.
  • RESOURCE_EXHAUSTED: There is insufficient quota of some resource to run the action.
  • UNAVAILABLE: Due to a transient condition, such as all workers being occupied (and the server does not support a queue), the action could not be started. The client should retry.
  • INTERNAL: An internal error occurred in the execution engine or the worker.
  • DEADLINE_EXCEEDED: The execution timed out.
  • CANCELLED: The operation was cancelled by the client. This status is only possible if the server implements the Operations API CancelOperation method, and it was called for the current execution. In the case of a missing input or command, the server SHOULD additionally send a PreconditionFailure error detail where, for each requested blob not present in the CAS, there is a Violation with a type of MISSING and a subject of "blobs/hash/size" indicating the digest of the missing blob.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


257
258
259
260
261
262
263
264
265
266
267
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 257

def execute_action(instance_name, build_bazel_remote_execution_v2_execute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+instanceName}/actions:execute', options)
  command.request_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ExecuteRequest::Representation
  command.request_object = build_bazel_remote_execution_v2_execute_request_object
  command.response_representation = Google::Apis::RemotebuildexecutionV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RemotebuildexecutionV2::GoogleLongrunningOperation
  command.params['instanceName'] = instance_name unless instance_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#find_blob_missing(instance_name, build_bazel_remote_execution_v2_find_missing_blobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2FindMissingBlobsResponse

Determine if blobs are present in the CAS. Clients can use this API before uploading blobs to determine which ones are already present in the CAS and do not need to be uploaded again. There are no method-specific errors.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


402
403
404
405
406
407
408
409
410
411
412
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 402

def find_blob_missing(instance_name, build_bazel_remote_execution_v2_find_missing_blobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+instanceName}/blobs:findMissing', options)
  command.request_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2FindMissingBlobsRequest::Representation
  command.request_object = build_bazel_remote_execution_v2_find_missing_blobs_request_object
  command.response_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2FindMissingBlobsResponse::Representation
  command.response_class = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2FindMissingBlobsResponse
  command.params['instanceName'] = instance_name unless instance_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_action_result(instance_name, hash_, size_bytes, inline_output_files: nil, inline_stderr: nil, inline_stdout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult

Retrieve a cached execution result. Implementations SHOULD ensure that any blobs referenced from the ContentAddressableStorage are available at the time of returning the ActionResult and will be for some period of time afterwards. The TTLs of the referenced blobs SHOULD be increased if necessary and applicable. Errors:

  • NOT_FOUND: The requested ActionResult is not in the cache.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 98

def get_action_result(instance_name, hash_, size_bytes, inline_output_files: nil, inline_stderr: nil, inline_stdout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+instanceName}/actionResults/{hash}/{sizeBytes}', options)
  command.response_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult::Representation
  command.response_class = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult
  command.params['instanceName'] = instance_name unless instance_name.nil?
  command.params['hash'] = hash_ unless hash_.nil?
  command.params['sizeBytes'] = size_bytes unless size_bytes.nil?
  command.query['inlineOutputFiles'] = inline_output_files unless inline_output_files.nil?
  command.query['inlineStderr'] = inline_stderr unless inline_stderr.nil?
  command.query['inlineStdout'] = inline_stdout unless inline_stdout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_blob_tree(instance_name, hash_, size_bytes, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2GetTreeResponse

Fetch the entire directory tree rooted at a node. This request must be targeted at a Directory stored in the ContentAddressableStorage (CAS). The server will enumerate the Directory tree recursively and return every node descended from the root. The GetTreeRequest.page_token parameter can be used to skip ahead in the stream (e.g. when retrying a partially completed and aborted request), by setting it to a value taken from GetTreeResponse.next_page_token of the last successfully processed GetTreeResponse). The exact traversal order is unspecified and, unless retrieving subsequent pages from an earlier request, is not guaranteed to be stable across multiple invocations of GetTree. If part of the tree is missing from the CAS, the server will return the portion present and omit the rest.

  • NOT_FOUND: The requested tree root is not present in the CAS.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


467
468
469
470
471
472
473
474
475
476
477
478
479
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 467

def get_blob_tree(instance_name, hash_, size_bytes, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+instanceName}/blobs/{hash}/{sizeBytes}:getTree', options)
  command.response_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2GetTreeResponse::Representation
  command.response_class = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2GetTreeResponse
  command.params['instanceName'] = instance_name unless instance_name.nil?
  command.params['hash'] = hash_ unless hash_.nil?
  command.params['sizeBytes'] = size_bytes unless size_bytes.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_capabilities(instance_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ServerCapabilities

GetCapabilities returns the server capabilities configuration of the remote endpoint. Only the capabilities of the services supported by the endpoint will be returned:

  • Execution + CAS + Action Cache endpoints should return both CacheCapabilities and ExecutionCapabilities.
  • Execution only endpoints should return ExecutionCapabilities.
  • CAS + Action Cache only endpoints should return CacheCapabilities.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


551
552
553
554
555
556
557
558
559
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 551

def get_capabilities(instance_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+instanceName}/capabilities', options)
  command.response_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ServerCapabilities::Representation
  command.response_class = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ServerCapabilities
  command.params['instanceName'] = instance_name unless instance_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_action_result(instance_name, hash_, size_bytes, build_bazel_remote_execution_v2_action_result_object = nil, results_cache_policy_priority: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult

Upload a new execution result. In order to allow the server to perform access control based on the type of action, and to assist with client debugging, the client MUST first upload the Action that produced the result, along with its Command, into the ContentAddressableStorage. Errors:

  • INVALID_ARGUMENT: One or more arguments are invalid.
  • FAILED_PRECONDITION: One or more errors occurred in updating the action result, such as a missing command or action.
  • RESOURCE_EXHAUSTED: There is insufficient storage space to add the entry to the cache.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 163

def update_action_result(instance_name, hash_, size_bytes, build_bazel_remote_execution_v2_action_result_object = nil, results_cache_policy_priority: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v2/{+instanceName}/actionResults/{hash}/{sizeBytes}', options)
  command.request_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult::Representation
  command.request_object = build_bazel_remote_execution_v2_action_result_object
  command.response_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult::Representation
  command.response_class = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult
  command.params['instanceName'] = instance_name unless instance_name.nil?
  command.params['hash'] = hash_ unless hash_.nil?
  command.params['sizeBytes'] = size_bytes unless size_bytes.nil?
  command.query['resultsCachePolicy.priority'] = results_cache_policy_priority unless results_cache_policy_priority.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_operation_execution(name, build_bazel_remote_execution_v2_wait_execution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RemotebuildexecutionV2::GoogleLongrunningOperation

Wait for an execution operation to complete. When the client initially makes the request, the server immediately responds with the current status of the execution. The server will leave the request stream open until the operation completes, and then respond with the completed operation. The server MAY choose to stream additional updates as execution progresses, such as to provide an update as to the state of the execution.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


508
509
510
511
512
513
514
515
516
517
518
# File 'generated/google/apis/remotebuildexecution_v2/service.rb', line 508

def wait_operation_execution(name, build_bazel_remote_execution_v2_wait_execution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:waitExecution', options)
  command.request_representation = Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2WaitExecutionRequest::Representation
  command.request_object = build_bazel_remote_execution_v2_wait_execution_request_object
  command.response_representation = Google::Apis::RemotebuildexecutionV2::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RemotebuildexecutionV2::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end