generated/google/apis/remotebuildexecution_v2/service.rb in google-api-client-0.43.0 vs generated/google/apis/remotebuildexecution_v2/service.rb in google-api-client-0.44.0

- old
+ new

@@ -45,41 +45,33 @@ def initialize super('https://remotebuildexecution.googleapis.com/', '') @batch_path = 'batch' end - # 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. + # 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. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [String] hash_ # The hash. In the case of SHA-256, it will always be a lowercase hex string # exactly 64 characters long. # @param [Fixnum] size_bytes # The size of the blob, in bytes. # @param [Array<String>, String] inline_output_files - # A hint to the server to inline the contents of the listed output files. - # Each path needs to exactly match one path in `output_files` in the - # Command message. + # A hint to the server to inline the contents of the listed output files. Each + # path needs to exactly match one path in `output_files` in the Command message. # @param [Boolean] inline_stderr - # A hint to the server to request inlining stderr in the - # ActionResult message. + # A hint to the server to request inlining stderr in the ActionResult message. # @param [Boolean] inline_stdout - # A hint to the server to request inlining stdout in the - # ActionResult message. + # A hint to the server to request inlining stdout in the ActionResult message. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. @@ -108,43 +100,37 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [String] hash_ # The hash. In the case of SHA-256, it will always be a lowercase hex string # exactly 64 characters long. # @param [Fixnum] size_bytes # The size of the blob, in bytes. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult] build_bazel_remote_execution_v2_action_result_object # @param [Fixnum] results_cache_policy_priority # The priority (relative importance) of this content in the overall cache. - # Generally, a lower value means a longer retention time or other advantage, - # but the interpretation of a given value is server-dependent. A priority of - # 0 means a *default* value, decided by the server. - # The particular semantics of this field is up to the server. In particular, - # every server will have their own supported range of priorities, and will - # decide how these map into retention/eviction policy. + # Generally, a lower value means a longer retention time or other advantage, but + # the interpretation of a given value is server-dependent. A priority of 0 means + # a *default* value, decided by the server. The particular semantics of this + # field is up to the server. In particular, every server will have their own + # supported range of priorities, and will decide how these map into retention/ + # eviction policy. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. @@ -173,71 +159,54 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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 `Action`s. 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. + # 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 `Action`s. 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. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ExecuteRequest] build_bazel_remote_execution_v2_execute_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -264,31 +233,24 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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 + # 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. + # 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. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchReadBlobsRequest] build_bazel_remote_execution_v2_batch_read_blobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -315,34 +277,26 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchUpdateBlobsRequest] build_bazel_remote_execution_v2_batch_update_blobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -369,22 +323,20 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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. - # Servers SHOULD increase the TTLs of the referenced blobs if necessary and - # applicable. - # There are no method-specific errors. + # 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. Servers SHOULD increase the TTLs of the + # referenced blobs if necessary and applicable. There are no method-specific + # errors. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2FindMissingBlobsRequest] build_bazel_remote_execution_v2_find_missing_blobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -411,33 +363,27 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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. - # Errors: - # * `NOT_FOUND`: The requested tree root is not present in the CAS. + # 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. Errors: * `NOT_FOUND`: The requested + # tree root is not present in the CAS. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [String] hash_ # The hash. In the case of SHA-256, it will always be a lowercase hex string # exactly 64 characters long. # @param [Fixnum] size_bytes # The size of the blob, in bytes. @@ -445,14 +391,13 @@ # A maximum page size to request. If present, the server will request no more # than this many items. Regardless of whether a page size is specified, the # server may place its own limit on the number of items to be returned and # require the client to retrieve more items using a subsequent request. # @param [String] page_token - # A page token, which must be a value received in a previous - # GetTreeResponse. - # If present, the server will use that token as an offset, returning only - # that page and the ones that succeed it. + # A page token, which must be a value received in a previous GetTreeResponse. If + # present, the server will use that token as an offset, returning only that page + # and the ones that succeed it. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters. @@ -480,19 +425,18 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] name - # The name of the Operation - # returned by Execute. + # The name of the Operation returned by Execute. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2WaitExecutionRequest] build_bazel_remote_execution_v2_wait_execution_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any @@ -519,23 +463,20 @@ command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # Available to use for quota purposes for server-side applications. Can be any # arbitrary string assigned to a user, but should not exceed 40 characters.