Class BuildBazelRemoteExecutionV2Command

A Command is the actual command executed by a worker running an Action and specifications of its environment. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API.

Inheritance

System.Object

BuildBazelRemoteExecutionV2Command

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 BuildBazelRemoteExecutionV2Command : IDirectResponseSchema

Properties

Arguments

The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path.

Declaration

[JsonProperty("arguments")]
public virtual IList<string> Arguments { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

EnvironmentVariables

The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent Commands always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes.

Declaration

[JsonProperty("environmentVariables")]
public virtual IList<BuildBazelRemoteExecutionV2CommandEnvironmentVariable> EnvironmentVariables { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<BuildBazelRemoteExecutionV2CommandEnvironmentVariable>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

OutputDirectories

A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in output_files. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (/) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. An output directory is allowed to be a parent of another output directory. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root. DEPRECATED since 2.1: Use output_paths instead.

Declaration

[JsonProperty("outputDirectories")]
public virtual IList<string> OutputDirectories { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

OutputFiles

A list of the output files that the client expects to retrieve from the action. Only the listed files, as well as directories listed in output_directories, will be returned to the client as output. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (/) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output file cannot be duplicated, be a parent of another output file, or have the same path as any of the listed output directories. Directories leading up to the output files are created by the worker prior to execution, even if they are not explicitly part of the input root. DEPRECATED since v2.1: Use output_paths instead.

Declaration

[JsonProperty("outputFiles")]
public virtual IList<string> OutputFiles { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

OutputNodeProperties

A list of keys for node properties the client expects to retrieve for output files and directories. Keys are either names of string-based NodeProperty or names of fields in NodeProperties. In order to ensure that equivalent Actions always hash to the same value, the node properties MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. The interpretation of string-based properties is server-dependent. If a property is not recognized by the server, the server will return an INVALID_ARGUMENT.

Declaration

[JsonProperty("outputNodeProperties")]
public virtual IList<string> OutputNodeProperties { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

OutputPaths

A list of the output paths that the client expects to retrieve from the action. Only the listed paths will be returned to the client as output. The type of the output (file or directory) is not specified, and will be determined by the server after action execution. If the resulting path is a file, it will be returned in an OutputFile) typed field. If the path is a directory, the entire directory structure will be returned as a Tree message digest, see OutputDirectory) Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (/) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be deduplicated and sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). Directories leading up to the output paths are created by the worker prior to execution, even if they are not explicitly part of the input root. New in v2.1: this field supersedes the DEPRECATED output_files and output_directories fields. If output_paths is used, output_files and output_directories will be ignored!

Declaration

[JsonProperty("outputPaths")]
public virtual IList<string> OutputPaths { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Platform

The 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. DEPRECATED as of v2.2: platform properties are now specified directly in the action. See documentation note in the Action for migration.

Declaration

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

Property Value

Type	Description
BuildBazelRemoteExecutionV2Platform

WorkingDirectory

The working directory, relative to the input root, for the command to run in. It must be a directory which exists in the input tree. If it is left empty, then the action is run in the input root.

Declaration

[JsonProperty("workingDirectory")]
public virtual string WorkingDirectory { get; set; }

Property Value

Type	Description
System.String

Implements

Google.Apis.Requests.IDirectResponseSchema