Class BuildBazelRemoteExecutionV2Action

An Action captures all the information about an execution which is required to reproduce it. Actions are the core component of the [Execution] service. A single Action represents a repeatable action that can be performed by the execution service. Actions can be succinctly identified by the digest of their wire format encoding and, once an Action has been executed, will be cached in the action cache. Future requests can then use the cached result rather than needing to run afresh. When a server completes execution of an Action, it MAY choose to cache the result in the ActionCache unless do_not_cache is true. Clients SHOULD expect the server to do so. By default, future calls to Execute the same Action will also serve their results from the cache. Clients must take care to understand the caching behaviour. Ideally, all Actions will be reproducible so that serving a result from cache is always desirable and correct.

Inheritance

System.Object

BuildBazelRemoteExecutionV2Action

Implements

Google.Apis.Requests.IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.RemoteBuildExecution.v1.Data

Assembly: Google.Apis.RemoteBuildExecution.v1.dll

Syntax

public class BuildBazelRemoteExecutionV2Action : IDirectResponseSchema

Properties

CommandDigest

The digest of the Command to run, which MUST be present in the ContentAddressableStorage.

Declaration

[JsonProperty("commandDigest")]
public virtual BuildBazelRemoteExecutionV2Digest CommandDigest { get; set; }

Property Value

Type	Description
BuildBazelRemoteExecutionV2Digest

DoNotCache

If true, then the Action's result cannot be cached, and in-flight requests for the same Action may not be merged.

Declaration

[JsonProperty("doNotCache")]
public virtual bool? DoNotCache { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

InputRootDigest

The digest of the root Directory for the input files. The files in the directory tree are available in the correct location on the build machine before the command is executed. The root directory, as well as every subdirectory and content blob referred to, MUST be in the ContentAddressableStorage.

Declaration

[JsonProperty("inputRootDigest")]
public virtual BuildBazelRemoteExecutionV2Digest InputRootDigest { get; set; }

Property Value

Type	Description
BuildBazelRemoteExecutionV2Digest

Platform

The optional platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. A detailed lexicon for this can be found in the accompanying platform.md. New in version 2.2: clients SHOULD set these platform properties as well as those in the Command. Servers SHOULD prefer those set here.

Declaration

[JsonProperty("platform")]
public virtual BuildBazelRemoteExecutionV2Platform Platform { get; set; }

Property Value

Type	Description
BuildBazelRemoteExecutionV2Platform

Salt

An optional additional salt value used to place this Action into a separate cache namespace from other instances having the same field contents. This salt typically comes from operational configuration specific to sources such as repo and service configuration, and allows disowning an entire set of ActionResults that might have been poisoned by buggy software or tool failures.

Declaration

[JsonProperty("salt")]
public virtual string Salt { get; set; }

Property Value

Type	Description
System.String

Timeout

A timeout after which the execution should be killed. If the timeout is absent, then the client is specifying that the execution should continue as long as the server will let it. The server SHOULD impose a timeout if the client does not specify one, however, if the client does specify a timeout that is longer than the server's maximum timeout, the server MUST reject the request. The timeout is a part of the Action message, and therefore two Actions with different timeouts are different, even if they are otherwise identical. This is because, if they were not, running an Action with a lower timeout than is required might result in a cache hit from an execution run with a longer timeout, hiding the fact that the timeout is too short. By encoding it directly in the Action, a lower timeout will result in a cache miss and the execution timeout will fail immediately, rather than whenever the cache entry gets evicted.

Declaration

[JsonProperty("timeout")]
public virtual object Timeout { get; set; }

Property Value

Type	Description
System.Object

Implements

Google.Apis.Requests.IDirectResponseSchema