GoogleApi.RemoteBuildExecution.V2.Api.ActionResults (google_api_remote_build_execution v0.15.0) View Source

API calls for all endpoints tagged ActionResults.

Link to this section Summary

Functions

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.

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.

Link to this section Functions

Link to this function

remotebuildexecution_action_results_get(connection, instance_name, hash, size_bytes, optional_params \\ [], opts \\ [])

View Source

Specs

remotebuildexecution_action_results_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RemoteBuildExecution.V2.Model.BuildBazelRemoteExecutionV2ActionResult.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.RemoteBuildExecution.V2.Connection.t) - Connection to server
  • instance_name (type: String.t) - 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.
  • hash (type: String.t) - The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
  • size_bytes (type: String.t) - The size of the blob, in bytes.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :inlineOutputFiles (type: list(String.t)) - 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.
    • :inlineStderr (type: boolean()) - A hint to the server to request inlining stderr in the ActionResult message.
    • :inlineStdout (type: boolean()) - A hint to the server to request inlining stdout in the ActionResult message.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RemoteBuildExecution.V2.Model.BuildBazelRemoteExecutionV2ActionResult{}} on success
  • {:error, info} on failure
Link to this function

remotebuildexecution_action_results_update(connection, instance_name, hash, size_bytes, optional_params \\ [], opts \\ [])

View Source

Specs

remotebuildexecution_action_results_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.RemoteBuildExecution.V2.Model.BuildBazelRemoteExecutionV2ActionResult.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.RemoteBuildExecution.V2.Connection.t) - Connection to server
  • instance_name (type: String.t) - 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.
  • hash (type: String.t) - The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
  • size_bytes (type: String.t) - The size of the blob, in bytes.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :"resultsCachePolicy.priority" (type: integer()) - 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.
    • :body (type: GoogleApi.RemoteBuildExecution.V2.Model.BuildBazelRemoteExecutionV2ActionResult.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RemoteBuildExecution.V2.Model.BuildBazelRemoteExecutionV2ActionResult{}} on success
  • {:error, info} on failure