source: vendor/google/apiclient-services/src/RemoteBuildExecution/Resource/Actions.php

<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\RemoteBuildExecution\Resource;

use Google\Service\RemoteBuildExecution\BuildBazelRemoteExecutionV2ExecuteRequest;
use Google\Service\RemoteBuildExecution\GoogleLongrunningOperation;

/**
 * The "actions" collection of methods.
 * Typical usage is:
 *  <code>
 *   $remotebuildexecutionService = new Google\Service\RemoteBuildExecution(...);
 *   $actions = $remotebuildexecutionService->actions;
 *  </code>
 */
class Actions extends \Google\Service\Resource
{
  /**
   * 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. The
   * server does not need to guarantee that a call to this method leads to at most
   * one execution of the action. The server MAY execute the action multiple
   * times, potentially in parallel. These redundant executions MAY continue to
   * run, even if the operation is completed. (actions.execute)
   *
   * @param string $instanceName 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 BuildBazelRemoteExecutionV2ExecuteRequest $postBody
   * @param array $optParams Optional parameters.
   * @return GoogleLongrunningOperation
   */
  public function execute($instanceName, BuildBazelRemoteExecutionV2ExecuteRequest $postBody, $optParams = [])
  {
    $params = ['instanceName' => $instanceName, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('execute', [$params], GoogleLongrunningOperation::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Actions::class, 'Google_Service_RemoteBuildExecution_Resource_Actions');