Documentation ¶
Overview ¶
Package remotebuildexecution provides access to the Remote Build Execution API.
For product documentation, see: https://cloud.google.com/remote-build-execution/docs/
Creating a client ¶
Usage example:
import "google.golang.org/api/remotebuildexecution/v1" ... ctx := context.Background() remotebuildexecutionService, err := remotebuildexecution.NewService(ctx)
In this example, Google Application Default Credentials are used for authentication.
For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options ¶
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
remotebuildexecutionService, err := remotebuildexecution.NewService(ctx, option.WithAPIKey("AIza..."))
To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
config := &oauth2.Config{...} // ... token, err := config.Exchange(ctx, ...) remotebuildexecutionService, err := remotebuildexecution.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type BuildBazelRemoteExecutionV2Action
- type BuildBazelRemoteExecutionV2ActionResult
- type BuildBazelRemoteExecutionV2Command
- type BuildBazelRemoteExecutionV2CommandEnvironmentVariable
- type BuildBazelRemoteExecutionV2Digest
- type BuildBazelRemoteExecutionV2Directory
- type BuildBazelRemoteExecutionV2DirectoryNode
- type BuildBazelRemoteExecutionV2ExecuteOperationMetadata
- type BuildBazelRemoteExecutionV2ExecuteResponse
- type BuildBazelRemoteExecutionV2ExecutedActionMetadata
- type BuildBazelRemoteExecutionV2FileNode
- type BuildBazelRemoteExecutionV2LogFile
- type BuildBazelRemoteExecutionV2OutputDirectory
- type BuildBazelRemoteExecutionV2OutputFile
- type BuildBazelRemoteExecutionV2OutputSymlink
- type BuildBazelRemoteExecutionV2Platform
- type BuildBazelRemoteExecutionV2PlatformProperty
- type BuildBazelRemoteExecutionV2RequestMetadata
- type BuildBazelRemoteExecutionV2SymlinkNode
- type BuildBazelRemoteExecutionV2ToolDetails
- type BuildBazelRemoteExecutionV2Tree
- type GoogleBytestreamMedia
- type GoogleDevtoolsRemotebuildbotCommandDurations
- type GoogleDevtoolsRemotebuildbotCommandEvents
- type GoogleDevtoolsRemotebuildbotCommandStatus
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig
- type GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool
- type GoogleDevtoolsRemoteexecutionV1testActionResult
- type GoogleDevtoolsRemoteexecutionV1testCommand
- type GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable
- type GoogleDevtoolsRemoteexecutionV1testDigest
- type GoogleDevtoolsRemoteexecutionV1testDirectory
- type GoogleDevtoolsRemoteexecutionV1testDirectoryNode
- type GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata
- type GoogleDevtoolsRemoteexecutionV1testExecuteResponse
- type GoogleDevtoolsRemoteexecutionV1testFileNode
- type GoogleDevtoolsRemoteexecutionV1testLogFile
- type GoogleDevtoolsRemoteexecutionV1testOutputDirectory
- type GoogleDevtoolsRemoteexecutionV1testOutputFile
- type GoogleDevtoolsRemoteexecutionV1testRequestMetadata
- type GoogleDevtoolsRemoteexecutionV1testToolDetails
- type GoogleDevtoolsRemoteexecutionV1testTree
- type GoogleDevtoolsRemoteworkersV1test2AdminTemp
- type GoogleDevtoolsRemoteworkersV1test2Blob
- type GoogleDevtoolsRemoteworkersV1test2CommandOutputs
- type GoogleDevtoolsRemoteworkersV1test2CommandOverhead
- type GoogleDevtoolsRemoteworkersV1test2CommandResult
- type GoogleDevtoolsRemoteworkersV1test2CommandTask
- type GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs
- type GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable
- type GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs
- type GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts
- type GoogleDevtoolsRemoteworkersV1test2Digest
- type GoogleDevtoolsRemoteworkersV1test2Directory
- type GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata
- type GoogleDevtoolsRemoteworkersV1test2FileMetadata
- type GoogleLongrunningCancelOperationRequest
- type GoogleLongrunningListOperationsResponse
- type GoogleLongrunningOperation
- type GoogleProtobufEmpty
- type GoogleRpcStatus
- type GoogleWatcherV1Change
- type GoogleWatcherV1ChangeBatch
- type MediaDownloadCall
- func (c *MediaDownloadCall) Context(ctx context.Context) *MediaDownloadCall
- func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*GoogleBytestreamMedia, error)
- func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response, error)
- func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall
- func (c *MediaDownloadCall) Header() http.Header
- func (c *MediaDownloadCall) IfNoneMatch(entityTag string) *MediaDownloadCall
- type MediaService
- type MediaUploadCall
- func (c *MediaUploadCall) Context(ctx context.Context) *MediaUploadCall
- func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*GoogleBytestreamMedia, error)
- func (c *MediaUploadCall) Fields(s ...googleapi.Field) *MediaUploadCall
- func (c *MediaUploadCall) Header() http.Header
- func (c *MediaUploadCall) Media(r io.Reader, options ...googleapi.MediaOption) *MediaUploadCall
- func (c *MediaUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MediaUploadCall
- func (c *MediaUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MediaUploadCalldeprecated
- type OperationsCancelCall
- func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall
- func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
- func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall
- func (c *OperationsCancelCall) Header() http.Header
- type OperationsDeleteCall
- func (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall
- func (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
- func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall
- func (c *OperationsDeleteCall) Header() http.Header
- type OperationsListCall
- func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
- func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
- func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
- func (c *OperationsListCall) Filter(filter string) *OperationsListCall
- func (c *OperationsListCall) Header() http.Header
- func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
- func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
- func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
- func (c *OperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
- type OperationsService
- type ProjectsOperationsGetCall
- func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall
- func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall
- func (c *ProjectsOperationsGetCall) Header() http.Header
- func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall
- type ProjectsOperationsService
- type ProjectsService
- type Service
- type V1Service
- type V1WatchCall
- func (c *V1WatchCall) Context(ctx context.Context) *V1WatchCall
- func (c *V1WatchCall) Do(opts ...googleapi.CallOption) (*GoogleWatcherV1ChangeBatch, error)
- func (c *V1WatchCall) Fields(s ...googleapi.Field) *V1WatchCall
- func (c *V1WatchCall) Header() http.Header
- func (c *V1WatchCall) IfNoneMatch(entityTag string) *V1WatchCall
- func (c *V1WatchCall) ResumeMarker(resumeMarker string) *V1WatchCall
- func (c *V1WatchCall) Target(target string) *V1WatchCall
Constants ¶
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildBazelRemoteExecutionV2Action ¶
type BuildBazelRemoteExecutionV2Action struct { // CommandDigest: The digest of the Command // to run, which MUST be present in the // ContentAddressableStorage. CommandDigest *BuildBazelRemoteExecutionV2Digest `json:"commandDigest,omitempty"` // DoNotCache: If true, then the `Action`'s result cannot be cached, and // in-flight // requests for the same `Action` may not be merged. DoNotCache bool `json:"doNotCache,omitempty"` // 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. InputRootDigest *BuildBazelRemoteExecutionV2Digest `json:"inputRootDigest,omitempty"` // 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. Timeout string `json:"timeout,omitempty"` // ForceSendFields is a list of field names (e.g. "CommandDigest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CommandDigest") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2Action: An `Action` captures all the information about an execution which is required to reproduce it.
`Action`s are the core component of the [Execution] service. A single `Action` represents a repeatable action that can be performed by the execution service. `Action`s 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 `Action`s will be reproducible so that serving a result from cache is always desirable and correct.
func (*BuildBazelRemoteExecutionV2Action) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2Action) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2ActionResult ¶
type BuildBazelRemoteExecutionV2ActionResult struct { // ExecutionMetadata: The details of the execution that originally // produced this result. ExecutionMetadata *BuildBazelRemoteExecutionV2ExecutedActionMetadata `json:"executionMetadata,omitempty"` // ExitCode: The exit code of the command. ExitCode int64 `json:"exitCode,omitempty"` // OutputDirectories: The output directories of the action. For each // output directory requested // in the `output_directories` field of the Action, if the // corresponding // directory existed after the action completed, a single entry will // be // present in the output list, which will contain the digest of a // Tree message containing the // directory tree, and the path equal exactly to the corresponding // Action // output_directories member. // // As an example, suppose the Action had an output directory `a/b/dir` // and the // execution produced the following contents in `a/b/dir`: a file named // `bar` // and a directory named `foo` with an executable file named `baz`. // Then, // output_directory will contain (hashes shortened for // readability): // // “`json // // OutputDirectory proto: // { // path: "a/b/dir" // tree_digest: { // hash: "4a73bc9d03...", // size: 55 // } // } // // Tree proto with hash "4a73bc9d03..." and size 55: // { // root: { // files: [ // { // name: "bar", // digest: { // hash: "4a73bc9d03...", // size: 65534 // } // } // ], // directories: [ // { // name: "foo", // digest: { // hash: "4cf2eda940...", // size: 43 // } // } // ] // } // children : { // // (Directory proto with hash "4cf2eda940..." and size 43) // files: [ // { // name: "baz", // digest: { // hash: "b2c941073e...", // size: 1294, // }, // is_executable: true // } // ] // } // } // “` // If an output of the same name was found, but was not a directory, // the // server will return a FAILED_PRECONDITION. OutputDirectories []*BuildBazelRemoteExecutionV2OutputDirectory `json:"outputDirectories,omitempty"` // OutputDirectorySymlinks: The output directories of the action that // are symbolic links to other // directories. Those may be links to other output directories, or // input // directories, or even absolute paths outside of the working // directory, // if the server supports // SymlinkAbsolutePathStrategy.ALLOWED. // For each output directory requested in the `output_directories` field // of // the Action, if the directory existed after the action completed, // a // single entry will be present either in this field, or in // the // `output_directories` field, if the directory was not a symbolic // link. // // If an output of the same name was found, but was a symbolic link to a // file // instead of a directory, the server will return a // FAILED_PRECONDITION. // If the action does not produce the requested output, then that // output // will be omitted from the list. The server is free to arrange the // output // list as desired; clients MUST NOT assume that the output list is // sorted. OutputDirectorySymlinks []*BuildBazelRemoteExecutionV2OutputSymlink `json:"outputDirectorySymlinks,omitempty"` // OutputFileSymlinks: The output files of the action that are symbolic // links to other files. Those // may be links to other output files, or input files, or even absolute // paths // outside of the working directory, if the server // supports // SymlinkAbsolutePathStrategy.ALLOWED. // For each output file requested in the `output_files` field of the // Action, // if the corresponding file existed after // the action completed, a single entry will be present either in this // field, // or in the `output_files` field, if the file was not a symbolic // link. // // If an output symbolic link of the same name was found, but its // target // type was not a regular file, the server will return a // FAILED_PRECONDITION. // If the action does not produce the requested output, then that // output // will be omitted from the list. The server is free to arrange the // output // list as desired; clients MUST NOT assume that the output list is // sorted. OutputFileSymlinks []*BuildBazelRemoteExecutionV2OutputSymlink `json:"outputFileSymlinks,omitempty"` // OutputFiles: The output files of the action. For each output file // requested in the // `output_files` field of the Action, if the corresponding file existed // after // the action completed, a single entry will be present either in this // field, // or the `output_file_symlinks` field if the file was a symbolic link // to // another file. // // If an output of the same name was found, but was a directory // rather // than a regular file, the server will return a FAILED_PRECONDITION. // If the action does not produce the requested output, then that // output // will be omitted from the list. The server is free to arrange the // output // list as desired; clients MUST NOT assume that the output list is // sorted. OutputFiles []*BuildBazelRemoteExecutionV2OutputFile `json:"outputFiles,omitempty"` // StderrDigest: The digest for a blob containing the standard error of // the action, which // can be retrieved from the // ContentAddressableStorage. StderrDigest *BuildBazelRemoteExecutionV2Digest `json:"stderrDigest,omitempty"` // StderrRaw: The standard error buffer of the action. The server SHOULD // NOT inline // stderr unless requested by the client in // the // GetActionResultRequest // message. The server MAY omit inlining, even if requested, and MUST do // so if inlining // would cause the response to exceed message size limits. StderrRaw string `json:"stderrRaw,omitempty"` // StdoutDigest: The digest for a blob containing the standard output of // the action, which // can be retrieved from the // ContentAddressableStorage. StdoutDigest *BuildBazelRemoteExecutionV2Digest `json:"stdoutDigest,omitempty"` // StdoutRaw: The standard output buffer of the action. The server // SHOULD NOT inline // stdout unless requested by the client in // the // GetActionResultRequest // message. The server MAY omit inlining, even if requested, and MUST do // so if inlining // would cause the response to exceed message size limits. StdoutRaw string `json:"stdoutRaw,omitempty"` // ForceSendFields is a list of field names (e.g. "ExecutionMetadata") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExecutionMetadata") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2ActionResult: An ActionResult represents the result of an Action being run.
func (*BuildBazelRemoteExecutionV2ActionResult) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2ActionResult) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2Command ¶
type BuildBazelRemoteExecutionV2Command struct { // 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. Arguments []string `json:"arguments,omitempty"` // 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. EnvironmentVariables []*BuildBazelRemoteExecutionV2CommandEnvironmentVariable `json:"environmentVariables,omitempty"` // 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. OutputDirectories []string `json:"outputDirectories,omitempty"` // 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. OutputFiles []string `json:"outputFiles,omitempty"` // 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. Platform *BuildBazelRemoteExecutionV2Platform `json:"platform,omitempty"` // 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. WorkingDirectory string `json:"workingDirectory,omitempty"` // ForceSendFields is a list of field names (e.g. "Arguments") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Arguments") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
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.
func (*BuildBazelRemoteExecutionV2Command) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2Command) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2CommandEnvironmentVariable ¶
type BuildBazelRemoteExecutionV2CommandEnvironmentVariable struct { // Name: The variable name. Name string `json:"name,omitempty"` // Value: The variable value. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2CommandEnvironmentVariable: An `EnvironmentVariable` is one variable to set in the running program's environment.
func (*BuildBazelRemoteExecutionV2CommandEnvironmentVariable) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2CommandEnvironmentVariable) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2Digest ¶
type BuildBazelRemoteExecutionV2Digest struct { // Hash: The hash. In the case of SHA-256, it will always be a lowercase // hex string // exactly 64 characters long. Hash string `json:"hash,omitempty"` // SizeBytes: The size of the blob, in bytes. SizeBytes int64 `json:"sizeBytes,omitempty,string"` // ForceSendFields is a list of field names (e.g. "Hash") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Hash") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2Digest: A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256.
The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request.
The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff.
When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message:
* Fields are serialized in tag order. * There are no unknown fields. * There are no duplicate fields. * Fields are serialized according to the default semantics for their type.
Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields.
func (*BuildBazelRemoteExecutionV2Digest) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2Digest) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2Directory ¶
type BuildBazelRemoteExecutionV2Directory struct { // Directories: The subdirectories in the directory. Directories []*BuildBazelRemoteExecutionV2DirectoryNode `json:"directories,omitempty"` // Files: The files in the directory. Files []*BuildBazelRemoteExecutionV2FileNode `json:"files,omitempty"` // Symlinks: The symlinks in the directory. Symlinks []*BuildBazelRemoteExecutionV2SymlinkNode `json:"symlinks,omitempty"` // ForceSendFields is a list of field names (e.g. "Directories") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Directories") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2Directory: A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory.
In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`:
* Every child in the directory must have a path of exactly one segment.
Multiple levels of directory hierarchy may not be collapsed.
* Each child in the directory must have a unique path segment (file name).
Note that while the API itself is case-sensitive, the environment
where
the Action is executed may or may not be case-sensitive. That is,
it is
legal to call the API with a Directory that has both "Foo" and
"foo" as
children, but the Action may be rejected by the remote system upon execution.
* The files, directories and symlinks in the directory must each be sorted
in lexicographical order by path. The path strings must be sorted
by code
point, equivalently, by UTF-8 bytes.
A `Directory` that obeys the restrictions is said to be in canonical form.
As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability):
```json // (Directory proto)
{ files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] }
// (Directory proto with hash "4cf2eda940..." and size 43)
{ files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] }
```
func (*BuildBazelRemoteExecutionV2Directory) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2Directory) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2DirectoryNode ¶
type BuildBazelRemoteExecutionV2DirectoryNode struct { // Digest: The digest of the // Directory object // represented. See Digest // for information about how to take the digest of a proto message. Digest *BuildBazelRemoteExecutionV2Digest `json:"digest,omitempty"` // Name: The name of the directory. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Digest") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2DirectoryNode: A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata.
func (*BuildBazelRemoteExecutionV2DirectoryNode) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2DirectoryNode) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2ExecuteOperationMetadata ¶
type BuildBazelRemoteExecutionV2ExecuteOperationMetadata struct { // ActionDigest: The digest of the Action // being executed. ActionDigest *BuildBazelRemoteExecutionV2Digest `json:"actionDigest,omitempty"` // Stage: The current stage of execution. // // Possible values: // "UNKNOWN" - Invalid value. // "CACHE_CHECK" - Checking the result against the cache. // "QUEUED" - Currently idle, awaiting a free machine to execute. // "EXECUTING" - Currently being executed by a worker. // "COMPLETED" - Finished execution. Stage string `json:"stage,omitempty"` // StderrStreamName: If set, the client can use this name // with // ByteStream.Read to stream the // standard error. StderrStreamName string `json:"stderrStreamName,omitempty"` // StdoutStreamName: If set, the client can use this name // with // ByteStream.Read to stream the // standard output. StdoutStreamName string `json:"stdoutStreamName,omitempty"` // ForceSendFields is a list of field names (e.g. "ActionDigest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ActionDigest") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2ExecuteOperationMetadata: Metadata about an ongoing execution, which will be contained in the metadata field of the Operation.
func (*BuildBazelRemoteExecutionV2ExecuteOperationMetadata) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2ExecuteOperationMetadata) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2ExecuteResponse ¶
type BuildBazelRemoteExecutionV2ExecuteResponse struct { // CachedResult: True if the result was served from cache, false if it // was executed. CachedResult bool `json:"cachedResult,omitempty"` // Message: Freeform informational message with details on the execution // of the action // that may be displayed to the user upon failure or when requested // explicitly. Message string `json:"message,omitempty"` // Result: The result of the action. Result *BuildBazelRemoteExecutionV2ActionResult `json:"result,omitempty"` // ServerLogs: An optional list of additional log outputs the server // wishes to provide. A // server can use this to return execution-specific logs however it // wishes. // This is intended primarily to make it easier for users to debug // issues that // may be outside of the actual job execution, such as by identifying // the // worker executing the action or by providing logs from the worker's // setup // phase. The keys SHOULD be human readable so that a client can display // them // to a user. ServerLogs map[string]BuildBazelRemoteExecutionV2LogFile `json:"serverLogs,omitempty"` // Status: If the status has a code other than `OK`, it indicates that // the action did // not finish execution. For example, if the operation times out // during // execution, the status will have a `DEADLINE_EXCEEDED` code. Servers // MUST // use this field for errors in execution, rather than the error field // on the // `Operation` object. // // If the status code is other than `OK`, then the result MUST NOT be // cached. // For an error status, the `result` field is optional; the server // may // populate the output-, stdout-, and stderr-related fields if it has // any // information available, such as the stdout and stderr of a timed-out // action. Status *GoogleRpcStatus `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "CachedResult") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CachedResult") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2ExecuteResponse: The response message for Execution.Execute, which will be contained in the response field of the Operation.
func (*BuildBazelRemoteExecutionV2ExecuteResponse) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2ExecuteResponse) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2ExecutedActionMetadata ¶
type BuildBazelRemoteExecutionV2ExecutedActionMetadata struct { // ExecutionCompletedTimestamp: When the worker completed executing the // action command. ExecutionCompletedTimestamp string `json:"executionCompletedTimestamp,omitempty"` // ExecutionStartTimestamp: When the worker started executing the action // command. ExecutionStartTimestamp string `json:"executionStartTimestamp,omitempty"` // InputFetchCompletedTimestamp: When the worker finished fetching // action inputs. InputFetchCompletedTimestamp string `json:"inputFetchCompletedTimestamp,omitempty"` // InputFetchStartTimestamp: When the worker started fetching action // inputs. InputFetchStartTimestamp string `json:"inputFetchStartTimestamp,omitempty"` // OutputUploadCompletedTimestamp: When the worker finished uploading // action outputs. OutputUploadCompletedTimestamp string `json:"outputUploadCompletedTimestamp,omitempty"` // OutputUploadStartTimestamp: When the worker started uploading action // outputs. OutputUploadStartTimestamp string `json:"outputUploadStartTimestamp,omitempty"` // QueuedTimestamp: When was the action added to the queue. QueuedTimestamp string `json:"queuedTimestamp,omitempty"` // Worker: The name of the worker which ran the execution. Worker string `json:"worker,omitempty"` // WorkerCompletedTimestamp: When the worker completed the action, // including all stages. WorkerCompletedTimestamp string `json:"workerCompletedTimestamp,omitempty"` // WorkerStartTimestamp: When the worker received the action. WorkerStartTimestamp string `json:"workerStartTimestamp,omitempty"` // ForceSendFields is a list of field names (e.g. // "ExecutionCompletedTimestamp") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "ExecutionCompletedTimestamp") to include in API requests with the // JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2ExecutedActionMetadata: ExecutedActionMetadata contains details about a completed execution.
func (*BuildBazelRemoteExecutionV2ExecutedActionMetadata) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2ExecutedActionMetadata) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2FileNode ¶
type BuildBazelRemoteExecutionV2FileNode struct { // Digest: The digest of the file's content. Digest *BuildBazelRemoteExecutionV2Digest `json:"digest,omitempty"` // IsExecutable: True if file is executable, false otherwise. IsExecutable bool `json:"isExecutable,omitempty"` // Name: The name of the file. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Digest") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2FileNode: A `FileNode` represents a single file and associated metadata.
func (*BuildBazelRemoteExecutionV2FileNode) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2FileNode) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2LogFile ¶
type BuildBazelRemoteExecutionV2LogFile struct { // Digest: The digest of the log contents. Digest *BuildBazelRemoteExecutionV2Digest `json:"digest,omitempty"` // HumanReadable: This is a hint as to the purpose of the log, and is // set to true if the log // is human-readable text that can be usefully displayed to a user, and // false // otherwise. For instance, if a command-line client wishes to print // the // server logs to the terminal for a failed action, this allows it to // avoid // displaying a binary file. HumanReadable bool `json:"humanReadable,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Digest") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2LogFile: A `LogFile` is a log stored in the CAS.
func (*BuildBazelRemoteExecutionV2LogFile) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2LogFile) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2OutputDirectory ¶
type BuildBazelRemoteExecutionV2OutputDirectory struct { // Path: The full path of the directory relative to the working // directory. The path // separator is a forward slash `/`. Since this is a relative path, it // MUST // NOT begin with a leading forward slash. The empty string value is // allowed, // and it denotes the entire working directory. Path string `json:"path,omitempty"` // TreeDigest: The digest of the encoded // Tree proto containing the // directory's contents. TreeDigest *BuildBazelRemoteExecutionV2Digest `json:"treeDigest,omitempty"` // ForceSendFields is a list of field names (e.g. "Path") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Path") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2OutputDirectory: An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file.
func (*BuildBazelRemoteExecutionV2OutputDirectory) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2OutputDirectory) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2OutputFile ¶
type BuildBazelRemoteExecutionV2OutputFile struct { // Contents: The contents of the file if inlining was requested. The // server SHOULD NOT inline // file contents unless requested by the client in // the // GetActionResultRequest // message. The server MAY omit inlining, even if requested, and MUST do // so if inlining // would cause the response to exceed message size limits. Contents string `json:"contents,omitempty"` // Digest: The digest of the file's content. Digest *BuildBazelRemoteExecutionV2Digest `json:"digest,omitempty"` // IsExecutable: True if file is executable, false otherwise. IsExecutable bool `json:"isExecutable,omitempty"` // Path: The full path of the file relative to the working directory, // including the // filename. The path separator is a forward slash `/`. Since this is // a // relative path, it MUST NOT begin with a leading forward slash. Path string `json:"path,omitempty"` // ForceSendFields is a list of field names (e.g. "Contents") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Contents") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2OutputFile: An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name.
func (*BuildBazelRemoteExecutionV2OutputFile) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2OutputFile) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2OutputSymlink ¶
type BuildBazelRemoteExecutionV2OutputSymlink struct { // Path: The full path of the symlink relative to the working directory, // including the // filename. The path separator is a forward slash `/`. Since this is // a // relative path, it MUST NOT begin with a leading forward slash. Path string `json:"path,omitempty"` // Target: The target path of the symlink. The path separator is a // forward slash `/`. // The target path can be relative to the parent directory of the // symlink or // it can be an absolute path starting with `/`. Support for absolute // paths // can be checked using the Capabilities // API. The canonical form forbids the substrings `/./` and `//` in the // target // path. `..` components are allowed anywhere in the target path. Target string `json:"target,omitempty"` // ForceSendFields is a list of field names (e.g. "Path") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Path") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2OutputSymlink: An `OutputSymlink` is similar to a Symlink, but it is used as an output in an `ActionResult`.
`OutputSymlink` is binary-compatible with `SymlinkNode`.
func (*BuildBazelRemoteExecutionV2OutputSymlink) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2OutputSymlink) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2Platform ¶
type BuildBazelRemoteExecutionV2Platform struct { // Properties: The properties that make up this platform. In order to // ensure that // equivalent `Platform`s always hash to the same value, the properties // MUST // be lexicographically sorted by name, and then by value. Sorting of // strings // is done by code point, equivalently, by the UTF-8 bytes. Properties []*BuildBazelRemoteExecutionV2PlatformProperty `json:"properties,omitempty"` // ForceSendFields is a list of field names (e.g. "Properties") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Properties") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2Platform: A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action's execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform.
func (*BuildBazelRemoteExecutionV2Platform) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2Platform) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2PlatformProperty ¶
type BuildBazelRemoteExecutionV2PlatformProperty struct { // Name: The property name. Name string `json:"name,omitempty"` // Value: The property value. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2PlatformProperty: A single property for the environment. The server is responsible for specifying the property `name`s that it accepts. If an unknown `name` is provided in the requirements for an Action, the server SHOULD reject the execution request. If permitted by the server, the same `name` may occur multiple times.
The server is also responsible for specifying the interpretation of property `value`s. For instance, a property describing how much RAM must be available may be interpreted as allowing a worker with 16GB to fulfill a request for 8GB, while a property describing the OS environment on which the action must be performed may require an exact match with the worker's OS.
The server MAY use the `value` of one or more properties to determine how it sets up the execution environment, such as by making specific system files available to the worker.
func (*BuildBazelRemoteExecutionV2PlatformProperty) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2PlatformProperty) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2RequestMetadata ¶
type BuildBazelRemoteExecutionV2RequestMetadata struct { // ActionId: An identifier that ties multiple requests to the same // action. // For example, multiple requests to the CAS, Action Cache, and // Execution // API are used in order to compile foo.cc. ActionId string `json:"actionId,omitempty"` // invocations together. For example, // runs of foo_test, bar_test and baz_test on a post-submit of a given // patch. CorrelatedInvocationsId string `json:"correlatedInvocationsId,omitempty"` // ToolDetails: The details for the tool invoking the requests. ToolDetails *BuildBazelRemoteExecutionV2ToolDetails `json:"toolDetails,omitempty"` // ToolInvocationId: An identifier that ties multiple actions together // to a final result. // For example, multiple actions are required to build and run foo_test. ToolInvocationId string `json:"toolInvocationId,omitempty"` // ForceSendFields is a list of field names (e.g. "ActionId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ActionId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2RequestMetadata: An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization:
* name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base 64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#reques ts). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message.
func (*BuildBazelRemoteExecutionV2RequestMetadata) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2RequestMetadata) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2SymlinkNode ¶
type BuildBazelRemoteExecutionV2SymlinkNode struct { // Name: The name of the symlink. Name string `json:"name,omitempty"` // Target: The target path of the symlink. The path separator is a // forward slash `/`. // The target path can be relative to the parent directory of the // symlink or // it can be an absolute path starting with `/`. Support for absolute // paths // can be checked using the Capabilities // API. The canonical form forbids the substrings `/./` and `//` in the // target // path. `..` components are allowed anywhere in the target path. Target string `json:"target,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2SymlinkNode: A `SymlinkNode` represents a symbolic link.
func (*BuildBazelRemoteExecutionV2SymlinkNode) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2SymlinkNode) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2ToolDetails ¶
type BuildBazelRemoteExecutionV2ToolDetails struct { // ToolName: Name of the tool, e.g. bazel. ToolName string `json:"toolName,omitempty"` // ToolVersion: Version of the tool used for the request, e.g. 5.0.3. ToolVersion string `json:"toolVersion,omitempty"` // ForceSendFields is a list of field names (e.g. "ToolName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ToolName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2ToolDetails: Details for the tool used to call the API.
func (*BuildBazelRemoteExecutionV2ToolDetails) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2ToolDetails) MarshalJSON() ([]byte, error)
type BuildBazelRemoteExecutionV2Tree ¶
type BuildBazelRemoteExecutionV2Tree struct { // Children: All the child directories: the directories referred to by // the root and, // recursively, all its children. In order to reconstruct the directory // tree, // the client must take the digests of each of the child directories and // then // build up a tree starting from the `root`. Children []*BuildBazelRemoteExecutionV2Directory `json:"children,omitempty"` // Root: The root directory in the tree. Root *BuildBazelRemoteExecutionV2Directory `json:"root,omitempty"` // ForceSendFields is a list of field names (e.g. "Children") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Children") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BuildBazelRemoteExecutionV2Tree: A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message.
func (*BuildBazelRemoteExecutionV2Tree) MarshalJSON ¶
func (s *BuildBazelRemoteExecutionV2Tree) MarshalJSON() ([]byte, error)
type GoogleBytestreamMedia ¶
type GoogleBytestreamMedia struct { // ResourceName: Name of the media resource. ResourceName string `json:"resourceName,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ResourceName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ResourceName") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleBytestreamMedia: Media resource.
func (*GoogleBytestreamMedia) MarshalJSON ¶
func (s *GoogleBytestreamMedia) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildbotCommandDurations ¶
type GoogleDevtoolsRemotebuildbotCommandDurations struct { // DockerPrep: The time spent preparing the command to be run in a // Docker container // (includes pulling the Docker image, if necessary). DockerPrep string `json:"dockerPrep,omitempty"` // Download: The time spent downloading the input files and constructing // the working // directory. Download string `json:"download,omitempty"` // Execution: The time spent executing the command (i.e., doing useful // work). Execution string `json:"execution,omitempty"` // IsoPrepDone: The timestamp when preparation is done and bot starts // downloading files. IsoPrepDone string `json:"isoPrepDone,omitempty"` // Overall: The time spent completing the command, in total. Overall string `json:"overall,omitempty"` // Stdout: The time spent uploading the stdout logs. Stdout string `json:"stdout,omitempty"` // Upload: The time spent uploading the output files. Upload string `json:"upload,omitempty"` // ForceSendFields is a list of field names (e.g. "DockerPrep") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DockerPrep") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildbotCommandDurations: CommandDuration contains the various duration metrics tracked when a bot performs a command.
func (*GoogleDevtoolsRemotebuildbotCommandDurations) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildbotCommandDurations) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildbotCommandEvents ¶
type GoogleDevtoolsRemotebuildbotCommandEvents struct { // DockerCacheHit: Indicates whether we are using a cached Docker image // (true) or had to pull // the Docker image (false) for this command. DockerCacheHit bool `json:"dockerCacheHit,omitempty"` // InputCacheMiss: The input cache miss ratio. InputCacheMiss float64 `json:"inputCacheMiss,omitempty"` // NumErrors: The number of errors reported. NumErrors uint64 `json:"numErrors,omitempty,string"` // NumWarnings: The number of warnings reported. NumWarnings uint64 `json:"numWarnings,omitempty,string"` // ForceSendFields is a list of field names (e.g. "DockerCacheHit") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DockerCacheHit") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildbotCommandEvents: CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command.
func (*GoogleDevtoolsRemotebuildbotCommandEvents) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildbotCommandEvents) MarshalJSON() ([]byte, error)
func (*GoogleDevtoolsRemotebuildbotCommandEvents) UnmarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildbotCommandEvents) UnmarshalJSON(data []byte) error
type GoogleDevtoolsRemotebuildbotCommandStatus ¶
type GoogleDevtoolsRemotebuildbotCommandStatus struct { // Code: The status code. // // Possible values: // "OK" - The command succeeded. // "INVALID_ARGUMENT" - The command input was invalid. // "DEADLINE_EXCEEDED" - The command had passed its expiry time while // it was still running. // "NOT_FOUND" - The resources requested by the command were not // found. // "PERMISSION_DENIED" - The command failed due to permission errors. // "INTERNAL" - The command failed because of some invariants expected // by the underlying // system have been broken. This usually indicates a bug wit the system. // "ABORTED" - The command was aborted. // "CLEANUP_ERROR" - The bot failed to do the cleanup, e.g. unable to // delete the command // working directory or the command process. // "DOWNLOAD_INPUTS_ERROR" - The bot failed to download the inputs. // "UNKNOWN" - Unknown error. // "UPLOAD_OUTPUTS_ERROR" - The bot failed to upload the outputs. // "DOCKER_LOGIN_ERROR" - The bot failed to login to docker. // "DOCKER_IMAGE_PULL_ERROR" - The bot failed to pull docker image. // "DOCKER_IMAGE_EXIST_ERROR" - The bot failed to check docker images. // "DUPLICATE_INPUTS" - The inputs contain duplicate files. // "DOCKER_IMAGE_PERMISSION_DENIED" - The bot doesn't have the // permissions to pull docker images. // "DOCKER_IMAGE_NOT_FOUND" - The docker image cannot be found. // "WORKING_DIR_NOT_FOUND" - Working directory is not found. // "WORKING_DIR_NOT_IN_BASE_DIR" - Working directory is not under the // base directory // "DOCKER_UNAVAILABLE" - There are issues with docker // service/runtime. Code string `json:"code,omitempty"` // Message: The error message. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildbotCommandStatus: The internal status of the command result.
func (*GoogleDevtoolsRemotebuildbotCommandStatus) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildbotCommandStatus) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig struct { // AcceleratorCount: The number of the guest accelerator cards exposed // to this VM. AcceleratorCount int64 `json:"acceleratorCount,omitempty,string"` // AcceleratorType: The type of accelerator to attach to this VM, e.g. // "nvidia-tesla-k80" for // nVidia Tesla K80. AcceleratorType string `json:"acceleratorType,omitempty"` // ForceSendFields is a list of field names (e.g. "AcceleratorCount") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AcceleratorCount") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig: AcceleratorConfig defines the accelerator cards to attach to the VM.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest struct { // Instance: Specifies the instance to create. // The name in the instance, if specified in the instance, is ignored. Instance *GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance `json:"instance,omitempty"` // InstanceId: ID of the created instance. // A valid `instance_id` must: // be 6-50 characters long, // contain only lowercase letters, digits, hyphens and // underscores, // start with a lowercase letter, and // end with a lowercase letter or a digit. InstanceId string `json:"instanceId,omitempty"` // Parent: Resource name of the project containing the instance. // Format: `projects/[PROJECT_ID]`. Parent string `json:"parent,omitempty"` // ForceSendFields is a list of field names (e.g. "Instance") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Instance") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest: The request used for `CreateInstance`.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest struct { // Parent: Resource name of the instance in which to create the new // worker pool. // Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Parent string `json:"parent,omitempty"` // PoolId: ID of the created worker pool. // A valid pool ID must: // be 6-50 characters long, // contain only lowercase letters, digits, hyphens and // underscores, // start with a lowercase letter, and // end with a lowercase letter or a digit. PoolId string `json:"poolId,omitempty"` // WorkerPool: Specifies the worker pool to create. // The name in the worker pool, if specified, is ignored. WorkerPool *GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool `json:"workerPool,omitempty"` // ForceSendFields is a list of field names (e.g. "Parent") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Parent") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest:
The request used for `CreateWorkerPool`.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest struct { // Name: Name of the instance to delete. // Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest: The request used for `DeleteInstance`.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest struct { // Name: Name of the worker pool to // delete. // Format: // `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerp // ools/[POOL_ID]`. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest:
The request used for DeleteWorkerPool.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest struct { // Name: Name of the instance to retrieve. // Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest: The request used for `GetInstance`.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest struct { // Name: Name of the worker pool to // retrieve. // Format: // `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/worke // rpools/[POOL_ID]`. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest: The request used for GetWorkerPool.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance struct { // Location: The location is a GCP region. Currently only `us-central1` // is supported. Location string `json:"location,omitempty"` // LoggingEnabled: Output only. Whether stack driver logging is enabled // for the instance. LoggingEnabled bool `json:"loggingEnabled,omitempty"` // Name: Output only. Instance resource name formatted // as: // `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. // Name should not be populated when creating an instance since it is // provided // in the `instance_id` field. Name string `json:"name,omitempty"` // State: Output only. State of the instance. // // Possible values: // "STATE_UNSPECIFIED" - Not a valid state, but the default value of // the enum. // "CREATING" - The instance is in state `CREATING` once // `CreateInstance` is called and // before the instance is ready for use. // "RUNNING" - The instance is in state `RUNNING` when it is ready for // use. // "INACTIVE" - An `INACTIVE` instance indicates that there is a // problem that needs to be // fixed. Such instances cannot be used for execution and instances // that // remain in this state for a significant period of time will be // removed // permanently. State string `json:"state,omitempty"` // ForceSendFields is a list of field names (e.g. "Location") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Location") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance: Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest struct { // Parent: Resource name of the project. // Format: `projects/[PROJECT_ID]`. Parent string `json:"parent,omitempty"` // ForceSendFields is a list of field names (e.g. "Parent") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Parent") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse struct { // Instances: The list of instances in a given project. Instances []*GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance `json:"instances,omitempty"` // ForceSendFields is a list of field names (e.g. "Instances") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Instances") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest struct { // Filter: Optional. A filter expression that filters resources listed // in // the response. The expression must specify the field name, a // comparison // operator, and the value that you want to use for filtering. The // value // must be a string, a number, or a boolean. String values // are // case-insensitive. // The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, // `<=` or // `<`. // The `:` operator can be used with string fields to match // substrings. // For non-string fields it is equivalent to the `=` operator. // The `:*` comparison can be used to test whether a key has been // defined. // // You can also filter on nested fields. // // To filter on multiple expressions, you can separate expression // using // `AND` and `OR` operators, using parentheses to specify precedence. // If // neither operator is specified, `AND` is assumed. // // Examples: // // Include only pools with more than 100 reserved // workers: // `(worker_count > 100) (worker_config.reserved = true)` // // Include only pools with a certain label or machines of the // n1-standard // family: // `worker_config.labels.key1 : * OR worker_config.machine_type: // n1-standard` Filter string `json:"filter,omitempty"` // Parent: Resource name of the instance. // Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Parent string `json:"parent,omitempty"` // ForceSendFields is a list of field names (e.g. "Filter") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Filter") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse struct { // WorkerPools: The list of worker pools in a given instance. WorkerPools []*GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool `json:"workerPools,omitempty"` // ForceSendFields is a list of field names (e.g. "WorkerPools") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "WorkerPools") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest struct { // UpdateMask: The update mask applies to worker_pool. For the // `FieldMask` // definition, // see // https://developers.google.com/protocol-buffers/docs/re // ference/google.protobuf#fieldmask // If an empty update_mask is provided, only the non-default valued // field in // the worker pool field will be updated. Note that in order to update a // field // to the default value (zero, false, empty string) an explicit // update_mask // must be provided. UpdateMask string `json:"updateMask,omitempty"` // WorkerPool: Specifies the worker pool to update. WorkerPool *GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool `json:"workerPool,omitempty"` // ForceSendFields is a list of field names (e.g. "UpdateMask") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "UpdateMask") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest:
The request used for UpdateWorkerPool.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig struct { // Accelerator: The accelerator card attached to each VM. Accelerator *GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig `json:"accelerator,omitempty"` // DiskSizeGb: Required. Size of the disk attached to the worker, in // GB. // See https://cloud.google.com/compute/docs/disks/ DiskSizeGb int64 `json:"diskSizeGb,omitempty,string"` // DiskType: Required. Disk Type to use for the worker. // See // [Storage // options](https://cloud.google.com/compute/docs/disks/#introdu // ction). // Currently only `pd-standard` is supported. DiskType string `json:"diskType,omitempty"` // Labels: Labels associated with the workers. // Label keys and values can be no longer than 63 characters, can only // contain // lowercase letters, numeric characters, underscores and // dashes. // International letters are permitted. Label keys must start with a // letter. // Label values are optional. // There can not be more than 64 labels per resource. Labels map[string]string `json:"labels,omitempty"` // MachineType: Required. Machine type of the worker, such as // `n1-standard-2`. // See https://cloud.google.com/compute/docs/machine-types for a list // of // supported machine types. Note that `f1-micro` and `g1-small` are not // yet // supported. MachineType string `json:"machineType,omitempty"` // MinCpuPlatform: Minimum CPU platform to use when creating the // worker. // See [CPU // Platforms](https://cloud.google.com/compute/docs/cpu-platforms). MinCpuPlatform string `json:"minCpuPlatform,omitempty"` // Reserved: Determines whether the worker is reserved (equivalent to a // Compute Engine // on-demand VM and therefore won't be preempted). // See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for // more // details. Reserved bool `json:"reserved,omitempty"` // ForceSendFields is a list of field names (e.g. "Accelerator") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Accelerator") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig: Defines the configuration to be used for a creating workers in the worker pool.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool ¶
type GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool struct { // Name: WorkerPool resource name formatted // as: // `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_I // D]`. // name should not be populated when creating a worker pool since it // is // provided in the `poolId` field. Name string `json:"name,omitempty"` // State: Output only. State of the worker pool. // // Possible values: // "STATE_UNSPECIFIED" - Not a valid state, but the default value of // the enum. // "CREATING" - The worker pool is in state `CREATING` once // `CreateWorkerPool` is called // and before all requested workers are ready. // "RUNNING" - The worker pool is in state `RUNNING` when all its // workers are ready for // use. // "UPDATING" - The worker pool is in state `UPDATING` once // `UpdateWorkerPool` is called // and before the new configuration has all the requested workers ready // for // use, and no older configuration has any workers. At that point the // state // transitions to `RUNNING`. // "DELETING" - The worker pool is in state `DELETING` once the // `Delete` method is called // and before the deletion completes. // "INACTIVE" - The worker pool is in state `INACTIVE` when the // instance hosting the // worker pool in not running. State string `json:"state,omitempty"` // WorkerConfig: Specifies the properties, such as machine type and disk // size, used for // creating workers in a worker pool. WorkerConfig *GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig `json:"workerConfig,omitempty"` // WorkerCount: The desired number of workers in the worker pool. Must // be a value between // 0 and 1000. WorkerCount int64 `json:"workerCount,omitempty,string"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool: A worker pool resource in the Remote Build Execution API.
func (*GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool) MarshalJSON ¶
func (s *GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testActionResult ¶
type GoogleDevtoolsRemoteexecutionV1testActionResult struct { // ExitCode: The exit code of the command. ExitCode int64 `json:"exitCode,omitempty"` // OutputDirectories: The output directories of the action. For each // output directory requested // in the `output_directories` field of the Action, if the // corresponding // directory existed after the action completed, a single entry will // be // present in the output list, which will contain the digest of // a Tree message containing // the directory tree, and the path equal exactly to the corresponding // Action // output_directories member. // As an example, suppose the Action had an output directory `a/b/dir` // and the // execution produced the following contents in `a/b/dir`: a file named // `bar` // and a directory named `foo` with an executable file named `baz`. // Then, // output_directory will contain (hashes shortened for // readability): // // “`json // // OutputDirectory proto: // { // path: "a/b/dir" // tree_digest: { // hash: "4a73bc9d03...", // size: 55 // } // } // // Tree proto with hash "4a73bc9d03..." and size 55: // { // root: { // files: [ // { // name: "bar", // digest: { // hash: "4a73bc9d03...", // size: 65534 // } // } // ], // directories: [ // { // name: "foo", // digest: { // hash: "4cf2eda940...", // size: 43 // } // } // ] // } // children : { // // (Directory proto with hash "4cf2eda940..." and size 43) // files: [ // { // name: "baz", // digest: { // hash: "b2c941073e...", // size: 1294, // }, // is_executable: true // } // ] // } // } // “` OutputDirectories []*GoogleDevtoolsRemoteexecutionV1testOutputDirectory `json:"outputDirectories,omitempty"` // OutputFiles: The output files of the action. For each output file // requested in the // `output_files` field of the Action, if the corresponding file existed // after // the action completed, a single entry will be present in the output // list. // // If the action does not produce the requested output, or produces // a // directory where a regular file is expected or vice versa, then that // output // will be omitted from the list. The server is free to arrange the // output // list as desired; clients MUST NOT assume that the output list is // sorted. OutputFiles []*GoogleDevtoolsRemoteexecutionV1testOutputFile `json:"outputFiles,omitempty"` // StderrDigest: The digest for a blob containing the standard error of // the action, which // can be retrieved from the // ContentAddressableStorage. // See `stderr_raw` for when this will be set. StderrDigest *GoogleDevtoolsRemoteexecutionV1testDigest `json:"stderrDigest,omitempty"` // StderrRaw: The standard error buffer of the action. The server will // determine, based // on the size of the buffer, whether to return it in raw form or to // return // a digest in `stderr_digest` that points to the buffer. If neither is // set, // then the buffer is empty. The client SHOULD NOT assume it will get // one of // the raw buffer or a digest on any given request and should be // prepared to // handle either. StderrRaw string `json:"stderrRaw,omitempty"` // StdoutDigest: The digest for a blob containing the standard output of // the action, which // can be retrieved from the // ContentAddressableStorage. // See `stdout_raw` for when this will be set. StdoutDigest *GoogleDevtoolsRemoteexecutionV1testDigest `json:"stdoutDigest,omitempty"` // StdoutRaw: The standard output buffer of the action. The server will // determine, based // on the size of the buffer, whether to return it in raw form or to // return // a digest in `stdout_digest` that points to the buffer. If neither is // set, // then the buffer is empty. The client SHOULD NOT assume it will get // one of // the raw buffer or a digest on any given request and should be // prepared to // handle either. StdoutRaw string `json:"stdoutRaw,omitempty"` // ForceSendFields is a list of field names (e.g. "ExitCode") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExitCode") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testActionResult: An ActionResult represents the result of an Action being run.
func (*GoogleDevtoolsRemoteexecutionV1testActionResult) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testActionResult) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testCommand ¶
type GoogleDevtoolsRemoteexecutionV1testCommand struct { // 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. // // The working directory will always be the input root. Arguments []string `json:"arguments,omitempty"` // 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 `Command`s 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. EnvironmentVariables []*GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable `json:"environmentVariables,omitempty"` // ForceSendFields is a list of field names (e.g. "Arguments") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Arguments") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testCommand: A `Command` is the actual command executed by a worker running an Action.
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.
func (*GoogleDevtoolsRemoteexecutionV1testCommand) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testCommand) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable ¶
type GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable struct { // Name: The variable name. Name string `json:"name,omitempty"` // Value: The variable value. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable: An `EnvironmentVariable` is one variable to set in the running program's environment.
func (*GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testCommandEnvironmentVariable) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testDigest ¶
type GoogleDevtoolsRemoteexecutionV1testDigest struct { // Hash: The hash. In the case of SHA-256, it will always be a lowercase // hex string // exactly 64 characters long. Hash string `json:"hash,omitempty"` // SizeBytes: The size of the blob, in bytes. SizeBytes int64 `json:"sizeBytes,omitempty,string"` // ForceSendFields is a list of field names (e.g. "Hash") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Hash") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testDigest: A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256.
The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request.
The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff.
When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message. - Fields are serialized in tag order. - There are no unknown fields. - There are no duplicate fields. - Fields are serialized according to the default semantics for their type.
Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields.
func (*GoogleDevtoolsRemoteexecutionV1testDigest) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testDigest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testDirectory ¶
type GoogleDevtoolsRemoteexecutionV1testDirectory struct { // Directories: The subdirectories in the directory. Directories []*GoogleDevtoolsRemoteexecutionV1testDirectoryNode `json:"directories,omitempty"` // Files: The files in the directory. Files []*GoogleDevtoolsRemoteexecutionV1testFileNode `json:"files,omitempty"` // ForceSendFields is a list of field names (e.g. "Directories") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Directories") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testDirectory: A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes and DirectoryNodes. Each `Node` contains its name in the directory, the digest of its content (either a file blob or a `Directory` proto), as well as possibly some metadata about the file or directory.
In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`:
- Every child in the directory must have a path of exactly one
segment.
Multiple levels of directory hierarchy may not be collapsed. - Each child in the directory must have a unique path segment (file
name).
- The files and directories in the directory must each be sorted
in
lexicographical order by path. The path strings must be sorted by
code
point, equivalently, by UTF-8 bytes.
A `Directory` that obeys the restrictions is said to be in canonical form.
As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability):
```json // (Directory proto)
{ files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] }
// (Directory proto with hash "4cf2eda940..." and size 43)
{ files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] }
```
func (*GoogleDevtoolsRemoteexecutionV1testDirectory) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testDirectory) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testDirectoryNode ¶
type GoogleDevtoolsRemoteexecutionV1testDirectoryNode struct { // Digest: The digest of the // Directory object // represented. See Digest // for information about how to take the digest of a proto message. Digest *GoogleDevtoolsRemoteexecutionV1testDigest `json:"digest,omitempty"` // Name: The name of the directory. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Digest") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testDirectoryNode: A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata.
func (*GoogleDevtoolsRemoteexecutionV1testDirectoryNode) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testDirectoryNode) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata ¶
type GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata struct { // ActionDigest: The digest of the Action // being executed. ActionDigest *GoogleDevtoolsRemoteexecutionV1testDigest `json:"actionDigest,omitempty"` // Possible values: // "UNKNOWN" // "CACHE_CHECK" - Checking the result against the cache. // "QUEUED" - Currently idle, awaiting a free machine to execute. // "EXECUTING" - Currently being executed by a worker. // "COMPLETED" - Finished execution. Stage string `json:"stage,omitempty"` // StderrStreamName: If set, the client can use this name // with // ByteStream.Read to stream the // standard error. StderrStreamName string `json:"stderrStreamName,omitempty"` // StdoutStreamName: If set, the client can use this name // with // ByteStream.Read to stream the // standard output. StdoutStreamName string `json:"stdoutStreamName,omitempty"` // ForceSendFields is a list of field names (e.g. "ActionDigest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ActionDigest") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata: Metadata about an ongoing execution, which will be contained in the metadata field of the Operation.
func (*GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testExecuteOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testExecuteResponse ¶
type GoogleDevtoolsRemoteexecutionV1testExecuteResponse struct { // CachedResult: True if the result was served from cache, false if it // was executed. CachedResult bool `json:"cachedResult,omitempty"` // Result: The result of the action. Result *GoogleDevtoolsRemoteexecutionV1testActionResult `json:"result,omitempty"` // ServerLogs: An optional list of additional log outputs the server // wishes to provide. A // server can use this to return execution-specific logs however it // wishes. // This is intended primarily to make it easier for users to debug // issues that // may be outside of the actual job execution, such as by identifying // the // worker executing the action or by providing logs from the worker's // setup // phase. The keys SHOULD be human readable so that a client can display // them // to a user. ServerLogs map[string]GoogleDevtoolsRemoteexecutionV1testLogFile `json:"serverLogs,omitempty"` // Status: If the status has a code other than `OK`, it indicates that // the action did // not finish execution. For example, if the operation times out // during // execution, the status will have a `DEADLINE_EXCEEDED` code. Servers // MUST // use this field for errors in execution, rather than the error field // on the // `Operation` object. // // If the status code is other than `OK`, then the result MUST NOT be // cached. // For an error status, the `result` field is optional; the server // may // populate the output-, stdout-, and stderr-related fields if it has // any // information available, such as the stdout and stderr of a timed-out // action. Status *GoogleRpcStatus `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "CachedResult") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CachedResult") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testExecuteResponse: The response message for Execution.Execute, which will be contained in the response field of the Operation.
func (*GoogleDevtoolsRemoteexecutionV1testExecuteResponse) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testExecuteResponse) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testFileNode ¶
type GoogleDevtoolsRemoteexecutionV1testFileNode struct { // Digest: The digest of the file's content. Digest *GoogleDevtoolsRemoteexecutionV1testDigest `json:"digest,omitempty"` // IsExecutable: True if file is executable, false otherwise. IsExecutable bool `json:"isExecutable,omitempty"` // Name: The name of the file. Name string `json:"name,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Digest") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testFileNode: A `FileNode` represents a single file and associated metadata.
func (*GoogleDevtoolsRemoteexecutionV1testFileNode) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testFileNode) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testLogFile ¶
type GoogleDevtoolsRemoteexecutionV1testLogFile struct { // Digest: The digest of the log contents. Digest *GoogleDevtoolsRemoteexecutionV1testDigest `json:"digest,omitempty"` // HumanReadable: This is a hint as to the purpose of the log, and is // set to true if the log // is human-readable text that can be usefully displayed to a user, and // false // otherwise. For instance, if a command-line client wishes to print // the // server logs to the terminal for a failed action, this allows it to // avoid // displaying a binary file. HumanReadable bool `json:"humanReadable,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Digest") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testLogFile: A `LogFile` is a log stored in the CAS.
func (*GoogleDevtoolsRemoteexecutionV1testLogFile) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testLogFile) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testOutputDirectory ¶
type GoogleDevtoolsRemoteexecutionV1testOutputDirectory struct { // Digest: DEPRECATED: This field is deprecated and should no longer be // used. Digest *GoogleDevtoolsRemoteexecutionV1testDigest `json:"digest,omitempty"` // Path: The full path of the directory relative to the working // directory. The path // separator is a forward slash `/`. Since this is a relative path, it // MUST // NOT begin with a leading forward slash. The empty string value is // allowed, // and it denotes the entire working directory. Path string `json:"path,omitempty"` // TreeDigest: The digest of the encoded // Tree proto containing the // directory's contents. TreeDigest *GoogleDevtoolsRemoteexecutionV1testDigest `json:"treeDigest,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Digest") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testOutputDirectory: An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file.
func (*GoogleDevtoolsRemoteexecutionV1testOutputDirectory) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testOutputDirectory) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testOutputFile ¶
type GoogleDevtoolsRemoteexecutionV1testOutputFile struct { // Content: The raw content of the file. // // This field may be used by the server to provide the content of a // file // inline in an // ActionResult and // avoid requiring that the client make a separate call // to // [ContentAddressableStorage.GetBlob] to retrieve it. // // The client SHOULD NOT assume that it will get raw content with any // request, // and always be prepared to retrieve it via `digest`. Content string `json:"content,omitempty"` // Digest: The digest of the file's content. Digest *GoogleDevtoolsRemoteexecutionV1testDigest `json:"digest,omitempty"` // IsExecutable: True if file is executable, false otherwise. IsExecutable bool `json:"isExecutable,omitempty"` // Path: The full path of the file relative to the input root, including // the // filename. The path separator is a forward slash `/`. Since this is // a // relative path, it MUST NOT begin with a leading forward slash. Path string `json:"path,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Content") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testOutputFile: An `OutputFile` is similar to a FileNode, but it is tailored for output as part of an `ActionResult`. It allows a full file path rather than only a name, and allows the server to include content inline.
`OutputFile` is binary-compatible with `FileNode`.
func (*GoogleDevtoolsRemoteexecutionV1testOutputFile) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testOutputFile) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testRequestMetadata ¶
type GoogleDevtoolsRemoteexecutionV1testRequestMetadata struct { // ActionId: An identifier that ties multiple requests to the same // action. // For example, multiple requests to the CAS, Action Cache, and // Execution // API are used in order to compile foo.cc. ActionId string `json:"actionId,omitempty"` // invocations together. For example, // runs of foo_test, bar_test and baz_test on a post-submit of a given // patch. CorrelatedInvocationsId string `json:"correlatedInvocationsId,omitempty"` // ToolDetails: The details for the tool invoking the requests. ToolDetails *GoogleDevtoolsRemoteexecutionV1testToolDetails `json:"toolDetails,omitempty"` // ToolInvocationId: An identifier that ties multiple actions together // to a final result. // For example, multiple actions are required to build and run foo_test. ToolInvocationId string `json:"toolInvocationId,omitempty"` // ForceSendFields is a list of field names (e.g. "ActionId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ActionId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testRequestMetadata: An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: name: google.devtools.remoteexecution.v1test.requestmetadata-bin contents: the base64 encoded binary RequestMetadata message.
func (*GoogleDevtoolsRemoteexecutionV1testRequestMetadata) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testRequestMetadata) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testToolDetails ¶
type GoogleDevtoolsRemoteexecutionV1testToolDetails struct { // ToolName: Name of the tool, e.g. bazel. ToolName string `json:"toolName,omitempty"` // ToolVersion: Version of the tool used for the request, e.g. 5.0.3. ToolVersion string `json:"toolVersion,omitempty"` // ForceSendFields is a list of field names (e.g. "ToolName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ToolName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testToolDetails: Details for the tool used to call the API.
func (*GoogleDevtoolsRemoteexecutionV1testToolDetails) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testToolDetails) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteexecutionV1testTree ¶
type GoogleDevtoolsRemoteexecutionV1testTree struct { // Children: All the child directories: the directories referred to by // the root and, // recursively, all its children. In order to reconstruct the directory // tree, // the client must take the digests of each of the child directories and // then // build up a tree starting from the `root`. Children []*GoogleDevtoolsRemoteexecutionV1testDirectory `json:"children,omitempty"` // Root: The root directory in the tree. Root *GoogleDevtoolsRemoteexecutionV1testDirectory `json:"root,omitempty"` // ForceSendFields is a list of field names (e.g. "Children") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Children") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteexecutionV1testTree: A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message.
func (*GoogleDevtoolsRemoteexecutionV1testTree) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteexecutionV1testTree) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2AdminTemp ¶
type GoogleDevtoolsRemoteworkersV1test2AdminTemp struct { // Arg: The argument to the admin action; see `Command` for semantics. Arg string `json:"arg,omitempty"` // Command: The admin action; see `Command` for legal values. // // Possible values: // "UNSPECIFIED" - Illegal value. // "BOT_UPDATE" - Download and run a new version of the bot. `arg` // will be a resource // accessible via `ByteStream.Read` to obtain the new bot code. // "BOT_RESTART" - Restart the bot without downloading a new version. // `arg` will be a // message to log. // "BOT_TERMINATE" - Shut down the bot. `arg` will be a task resource // name (similar to those // in tasks.proto) that the bot can use to tell the server that it // is // terminating. // "HOST_RESTART" - Restart the host computer. `arg` will be a message // to log. Command string `json:"command,omitempty"` // ForceSendFields is a list of field names (e.g. "Arg") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Arg") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2AdminTemp: AdminTemp is a prelimiary set of administration tasks. It's called "Temp" because we do not yet know the best way to represent admin tasks; it's possible that this will be entirely replaced in later versions of this API. If this message proves to be sufficient, it will be renamed in the alpha or beta release of this API.
This message (suitably marshalled into a protobuf.Any) can be used as the inline_assignment field in a lease; the lease assignment field should simply be "admin" in these cases.
This message is heavily based on Swarming administration tasks from the LUCI project (http://github.com/luci/luci-py/appengine/swarming).
func (*GoogleDevtoolsRemoteworkersV1test2AdminTemp) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2AdminTemp) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2Blob ¶
type GoogleDevtoolsRemoteworkersV1test2Blob struct { // Contents: The contents of the blob. Contents string `json:"contents,omitempty"` // Digest: The digest of the blob. This should be verified by the // receiver. Digest *GoogleDevtoolsRemoteworkersV1test2Digest `json:"digest,omitempty"` // ForceSendFields is a list of field names (e.g. "Contents") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Contents") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2Blob: Describes a blob of binary content with its digest.
func (*GoogleDevtoolsRemoteworkersV1test2Blob) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2Blob) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2CommandOutputs ¶
type GoogleDevtoolsRemoteworkersV1test2CommandOutputs struct { // ExitCode: exit_code is only fully reliable if the status' code is OK. // If the task // exceeded its deadline or was cancelled, the process may still produce // an // exit code as it is cancelled, and this will be populated, but a // successful // (zero) is unlikely to be correct unless the status code is OK. ExitCode int64 `json:"exitCode,omitempty"` // Outputs: The output files. The blob referenced by the digest should // contain // one of the following (implementation-dependent): // * A marshalled DirectoryMetadata of the returned filesystem // * A LUCI-style .isolated file Outputs *GoogleDevtoolsRemoteworkersV1test2Digest `json:"outputs,omitempty"` // ForceSendFields is a list of field names (e.g. "ExitCode") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExitCode") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2CommandOutputs: DEPRECATED - use CommandResult instead. Describes the actual outputs from the task.
func (*GoogleDevtoolsRemoteworkersV1test2CommandOutputs) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2CommandOutputs) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2CommandOverhead ¶
type GoogleDevtoolsRemoteworkersV1test2CommandOverhead struct { // Duration: The elapsed time between calling Accept and Complete. The // server will also // have its own idea of what this should be, but this excludes the // overhead of // the RPCs and the bot response time. Duration string `json:"duration,omitempty"` // Overhead: The amount of time *not* spent executing the command // (ie // uploading/downloading files). Overhead string `json:"overhead,omitempty"` // ForceSendFields is a list of field names (e.g. "Duration") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Duration") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2CommandOverhead: DEPRECATED - use CommandResult instead. Can be used as part of CompleteRequest.metadata, or are part of a more sophisticated message.
func (*GoogleDevtoolsRemoteworkersV1test2CommandOverhead) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2CommandOverhead) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2CommandResult ¶
type GoogleDevtoolsRemoteworkersV1test2CommandResult struct { // Duration: The elapsed time between calling Accept and Complete. The // server will also // have its own idea of what this should be, but this excludes the // overhead of // the RPCs and the bot response time. Duration string `json:"duration,omitempty"` // ExitCode: The exit code of the process. An exit code of "0" should // only be trusted if // `status` has a code of OK (otherwise it may simply be unset). ExitCode int64 `json:"exitCode,omitempty"` // Metadata: Implementation-dependent metadata about the task. Both // servers and bots // may define messages which can be encoded here; bots are free to // provide // metadata in multiple formats, and servers are free to choose one or // more // of the values to process and ignore others. In particular, it is // *not* // considered an error for the bot to provide the server with a field // that it // doesn't know about. Metadata []googleapi.RawMessage `json:"metadata,omitempty"` // Outputs: The output files. The blob referenced by the digest should // contain // one of the following (implementation-dependent): // * A marshalled DirectoryMetadata of the returned filesystem // * A LUCI-style .isolated file Outputs *GoogleDevtoolsRemoteworkersV1test2Digest `json:"outputs,omitempty"` // Overhead: The amount of time *not* spent executing the command // (ie // uploading/downloading files). Overhead string `json:"overhead,omitempty"` // Status: An overall status for the command. For example, if the // command timed out, // this might have a code of DEADLINE_EXCEEDED; if it was killed by the // OS for // memory exhaustion, it might have a code of RESOURCE_EXHAUSTED. Status *GoogleRpcStatus `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "Duration") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Duration") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2CommandResult: All information about the execution of a command, suitable for providing as the Bots interface's `Lease.result` field.
func (*GoogleDevtoolsRemoteworkersV1test2CommandResult) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2CommandResult) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2CommandTask ¶
type GoogleDevtoolsRemoteworkersV1test2CommandTask struct { // ExpectedOutputs: The expected outputs from the task. ExpectedOutputs *GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs `json:"expectedOutputs,omitempty"` // Inputs: The inputs to the task. Inputs *GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs `json:"inputs,omitempty"` // Timeouts: The timeouts of this task. Timeouts *GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts `json:"timeouts,omitempty"` // ForceSendFields is a list of field names (e.g. "ExpectedOutputs") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExpectedOutputs") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2CommandTask: Describes a shell-style task to execute, suitable for providing as the Bots interface's `Lease.payload` field.
func (*GoogleDevtoolsRemoteworkersV1test2CommandTask) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2CommandTask) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs ¶
type GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs struct { // Arguments: The command itself to run (e.g., argv). // // This field should be passed directly to the underlying operating // system, // and so it must be sensible to that operating system. For example, // on // Windows, the first argument might be "C:\Windows\System32\ping.exe" // - // that is, using drive letters and backslashes. A command for a // *nix // system, on the other hand, would use forward slashes. // // All other fields in the RWAPI must consistently use forward // slashes, // since those fields may be interpretted by both the service and the // bot. Arguments []string `json:"arguments,omitempty"` // EnvironmentVariables: All environment variables required by the task. EnvironmentVariables []*GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable `json:"environmentVariables,omitempty"` // Files: The input filesystem to be set up prior to the task beginning. // The // contents should be a repeated set of FileMetadata messages though // other // formats are allowed if better for the implementation (eg, a // LUCI-style // .isolated file). // // This field is repeated since implementations might want to cache // the // metadata, in which case it may be useful to break up portions of // the // filesystem that change frequently (eg, specific input files) from // those // that don't (eg, standard header files). Files []*GoogleDevtoolsRemoteworkersV1test2Digest `json:"files,omitempty"` // InlineBlobs: Inline contents for blobs expected to be needed by the // bot to execute the // task. For example, contents of entries in `files` or blobs that // are // indirectly referenced by an entry there. // // The bot should check against this list before downloading required // task // inputs to reduce the number of communications between itself and // the // remote CAS server. InlineBlobs []*GoogleDevtoolsRemoteworkersV1test2Blob `json:"inlineBlobs,omitempty"` // WorkingDirectory: Directory from which a command is executed. It is a // relative directory // with respect to the bot's working directory (i.e., "./"). If it // is // non-empty, then it must exist under "./". Otherwise, "./" will be // used. WorkingDirectory string `json:"workingDirectory,omitempty"` // ForceSendFields is a list of field names (e.g. "Arguments") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Arguments") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs: Describes the inputs to a shell-style task.
func (*GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable ¶
type GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable struct { // Name: The envvar name. Name string `json:"name,omitempty"` // Value: The envvar value. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Name") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Name") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable : An environment variable required by this task.
func (*GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs ¶
type GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs struct { // Directories: A list of expected directories, relative to the // execution root. All paths // MUST be delimited by forward slashes. Directories []string `json:"directories,omitempty"` // Files: A list of expected files, relative to the execution root. All // paths // MUST be delimited by forward slashes. Files []string `json:"files,omitempty"` // StderrDestination: The destination to which any stderr should be // sent. The method by which // the bot should send the stream contents to that destination is // not // defined in this API. As examples, the destination could be a // file // referenced in the `files` field in this message, or it could be a // URI // that must be written via the ByteStream API. StderrDestination string `json:"stderrDestination,omitempty"` // StdoutDestination: The destination to which any stdout should be // sent. The method by which // the bot should send the stream contents to that destination is // not // defined in this API. As examples, the destination could be a // file // referenced in the `files` field in this message, or it could be a // URI // that must be written via the ByteStream API. StdoutDestination string `json:"stdoutDestination,omitempty"` // ForceSendFields is a list of field names (e.g. "Directories") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Directories") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs: Describes the expected outputs of the command.
func (*GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts ¶
type GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts struct { // Execution: This specifies the maximum time that the task can run, // excluding the // time required to download inputs or upload outputs. That is, the // worker // will terminate the task if it runs longer than this. Execution string `json:"execution,omitempty"` // Idle: This specifies the maximum amount of time the task can be idle // - that is, // go without generating some output in either stdout or stderr. If // the // process is silent for more than the specified time, the worker // will // terminate the task. Idle string `json:"idle,omitempty"` // Shutdown: If the execution or IO timeouts are exceeded, the worker // will try to // gracefully terminate the task and return any existing logs. // However, // tasks may be hard-frozen in which case this process will fail. // This // timeout specifies how long to wait for a terminated task to shut // down // gracefully (e.g. via SIGTERM) before we bring down the hammer // (e.g. // SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). Shutdown string `json:"shutdown,omitempty"` // ForceSendFields is a list of field names (e.g. "Execution") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Execution") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts: Describes the timeouts associated with this task.
func (*GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2Digest ¶
type GoogleDevtoolsRemoteworkersV1test2Digest struct { // Hash: A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, // 0x2b, 0x3c]) // using an implementation-defined hash algorithm (eg SHA-256). Hash string `json:"hash,omitempty"` // SizeBytes: The size of the contents. While this is not strictly // required as part of an // identifier (after all, any given hash will have exactly one // canonical // size), it's useful in almost all cases when one might want to send // or // retrieve blobs of content and is included here for this reason. SizeBytes int64 `json:"sizeBytes,omitempty,string"` // ForceSendFields is a list of field names (e.g. "Hash") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Hash") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2Digest: The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a "digest." The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's "ContentAddressibleStorage" interface.
In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message.
func (*GoogleDevtoolsRemoteworkersV1test2Digest) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2Digest) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2Directory ¶
type GoogleDevtoolsRemoteworkersV1test2Directory struct { // Directories: Any subdirectories Directories []*GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata `json:"directories,omitempty"` // Files: The files in this directory Files []*GoogleDevtoolsRemoteworkersV1test2FileMetadata `json:"files,omitempty"` // ForceSendFields is a list of field names (e.g. "Directories") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Directories") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2Directory: The contents of a directory. Similar to the equivalent message in the Remote Execution API.
func (*GoogleDevtoolsRemoteworkersV1test2Directory) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2Directory) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata ¶
type GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata struct { // Digest: A pointer to the contents of the directory, in the form of a // marshalled // Directory message. Digest *GoogleDevtoolsRemoteworkersV1test2Digest `json:"digest,omitempty"` // Path: The path of the directory, as in FileMetadata.path. Path string `json:"path,omitempty"` // ForceSendFields is a list of field names (e.g. "Digest") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Digest") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata: The metadata for a directory. Similar to the equivalent message in the Remote Execution API.
func (*GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata) MarshalJSON() ([]byte, error)
type GoogleDevtoolsRemoteworkersV1test2FileMetadata ¶
type GoogleDevtoolsRemoteworkersV1test2FileMetadata struct { // Contents: If the file is small enough, its contents may also or // alternatively be // listed here. Contents string `json:"contents,omitempty"` // Digest: A pointer to the contents of the file. The method by which a // client // retrieves the contents from a CAS system is not defined here. Digest *GoogleDevtoolsRemoteworkersV1test2Digest `json:"digest,omitempty"` // IsExecutable: Properties of the file IsExecutable bool `json:"isExecutable,omitempty"` // Path: The path of this file. If this message is part of // the // CommandOutputs.outputs fields, the path is relative to the execution // root // and must correspond to an entry in CommandTask.outputs.files. If // this // message is part of a Directory message, then the path is relative to // the // root of that directory. All paths MUST be delimited by forward // slashes. Path string `json:"path,omitempty"` // ForceSendFields is a list of field names (e.g. "Contents") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Contents") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleDevtoolsRemoteworkersV1test2FileMetadata: The metadata for a file. Similar to the equivalent message in the Remote Execution API.
func (*GoogleDevtoolsRemoteworkersV1test2FileMetadata) MarshalJSON ¶
func (s *GoogleDevtoolsRemoteworkersV1test2FileMetadata) MarshalJSON() ([]byte, error)
type GoogleLongrunningCancelOperationRequest ¶
type GoogleLongrunningCancelOperationRequest struct { }
GoogleLongrunningCancelOperationRequest: The request message for Operations.CancelOperation.
type GoogleLongrunningListOperationsResponse ¶
type GoogleLongrunningListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*GoogleLongrunningOperation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleLongrunningListOperationsResponse: The response message for Operations.ListOperations.
func (*GoogleLongrunningListOperationsResponse) MarshalJSON ¶
func (s *GoogleLongrunningListOperationsResponse) MarshalJSON() ([]byte, error)
type GoogleLongrunningOperation ¶
type GoogleLongrunningOperation struct { // Done: If the value is `false`, it means the operation is still in // progress. // If `true`, the operation is completed, and either `error` or // `response` is // available. Done bool `json:"done,omitempty"` // Error: The error result of the operation in case of failure or // cancellation. Error *GoogleRpcStatus `json:"error,omitempty"` // Metadata: Service-specific metadata associated with the operation. // It typically // contains progress information and common metadata such as create // time. // Some services might not provide such metadata. Any method that // returns a // long-running operation should document the metadata type, if any. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: The server-assigned name, which is only unique within the same // service that // originally returns it. If you use the default HTTP mapping, // the // `name` should be a resource name ending with // `operations/{unique_id}`. Name string `json:"name,omitempty"` // Response: The normal response of the operation in case of success. // If the original // method returns no data on success, such as `Delete`, the response // is // `google.protobuf.Empty`. If the original method is // standard // `Get`/`Create`/`Update`, the response should be the resource. For // other // methods, the response should have the type `XxxResponse`, where // `Xxx` // is the original method name. For example, if the original method // name // is `TakeSnapshot()`, the inferred response type // is // `TakeSnapshotResponse`. Response googleapi.RawMessage `json:"response,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Done") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Done") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleLongrunningOperation: This resource represents a long-running operation that is the result of a network API call.
func (*GoogleLongrunningOperation) MarshalJSON ¶
func (s *GoogleLongrunningOperation) MarshalJSON() ([]byte, error)
type GoogleProtobufEmpty ¶
type GoogleProtobufEmpty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
GoogleProtobufEmpty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
service Foo { rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
}
The JSON representation for `Empty` is empty JSON object `{}`.
type GoogleRpcStatus ¶
type GoogleRpcStatus struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of // message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any // user-facing error message should be localized and sent in // the // google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
func (*GoogleRpcStatus) MarshalJSON ¶
func (s *GoogleRpcStatus) MarshalJSON() ([]byte, error)
type GoogleWatcherV1Change ¶
type GoogleWatcherV1Change struct { // Continued: If true, this Change is followed by more Changes that are // in the same group // as this Change. Continued bool `json:"continued,omitempty"` // Data: The actual change data. This field is present only when // `state() == EXISTS` // or `state() == ERROR`. Please see google.protobuf.Any about how to // use // the Any type. Data googleapi.RawMessage `json:"data,omitempty"` // Element: Name of the element, interpreted relative to the entity's // actual // name. "" refers to the entity itself. The element name is a // valid // UTF-8 string. Element string `json:"element,omitempty"` // ResumeMarker: If present, provides a compact representation of all // the messages that have // been received by the caller for the given entity, e.g., it could be // a // sequence number or a multi-part timestamp/version vector. This marker // can // be provided in the Request message, allowing the caller to resume // the // stream watching at a specific point without fetching the initial // state. ResumeMarker string `json:"resumeMarker,omitempty"` // State: The state of the `element`. // // Possible values: // "EXISTS" - The element exists and its full value is included in // data. // "DOES_NOT_EXIST" - The element does not exist. // "INITIAL_STATE_SKIPPED" - Element may or may not exist. Used only // for initial state delivery when // the client is not interested in fetching the initial state. See // the // "Initial State" section above. // "ERROR" - The element may exist, but some error has occurred. More // information is // available in the data field - the value is a serialized Status // proto (from google.rpc.Status) State string `json:"state,omitempty"` // ForceSendFields is a list of field names (e.g. "Continued") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Continued") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleWatcherV1Change: A Change indicates the most recent state of an element.
func (*GoogleWatcherV1Change) MarshalJSON ¶
func (s *GoogleWatcherV1Change) MarshalJSON() ([]byte, error)
type GoogleWatcherV1ChangeBatch ¶
type GoogleWatcherV1ChangeBatch struct { // Changes: A list of Change messages. Changes []*GoogleWatcherV1Change `json:"changes,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Changes") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Changes") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
GoogleWatcherV1ChangeBatch: A batch of Change messages.
func (*GoogleWatcherV1ChangeBatch) MarshalJSON ¶
func (s *GoogleWatcherV1ChangeBatch) MarshalJSON() ([]byte, error)
type MediaDownloadCall ¶
type MediaDownloadCall struct {
// contains filtered or unexported fields
}
func (*MediaDownloadCall) Context ¶
func (c *MediaDownloadCall) Context(ctx context.Context) *MediaDownloadCall
Context sets the context to be used in this call's Do and Download methods. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MediaDownloadCall) Do ¶
func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*GoogleBytestreamMedia, error)
Do executes the "remotebuildexecution.media.download" call. Exactly one of *GoogleBytestreamMedia or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleBytestreamMedia.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MediaDownloadCall) Download ¶
func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response, error)
Download fetches the API endpoint's "media" value, instead of the normal API response value. If the returned error is nil, the Response is guaranteed to have a 2xx status code. Callers must close the Response.Body as usual.
func (*MediaDownloadCall) Fields ¶
func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MediaDownloadCall) Header ¶
func (c *MediaDownloadCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MediaDownloadCall) IfNoneMatch ¶
func (c *MediaDownloadCall) IfNoneMatch(entityTag string) *MediaDownloadCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type MediaService ¶
type MediaService struct {
// contains filtered or unexported fields
}
func NewMediaService ¶
func NewMediaService(s *Service) *MediaService
func (*MediaService) Download ¶
func (r *MediaService) Download(resourceName string) *MediaDownloadCall
Download: Downloads media. Download is supported on the URI `/v1/media/{+name}?alt=media`.
func (*MediaService) Upload ¶
func (r *MediaService) Upload(resourceName string, googlebytestreammedia *GoogleBytestreamMedia) *MediaUploadCall
Upload: Uploads media. Upload is supported on the URI `/upload/v1/media/{+name}`.
type MediaUploadCall ¶
type MediaUploadCall struct {
// contains filtered or unexported fields
}
func (*MediaUploadCall) Context ¶
func (c *MediaUploadCall) Context(ctx context.Context) *MediaUploadCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled. This context will supersede any context previously provided to the ResumableMedia method.
func (*MediaUploadCall) Do ¶
func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*GoogleBytestreamMedia, error)
Do executes the "remotebuildexecution.media.upload" call. Exactly one of *GoogleBytestreamMedia or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleBytestreamMedia.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*MediaUploadCall) Fields ¶
func (c *MediaUploadCall) Fields(s ...googleapi.Field) *MediaUploadCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MediaUploadCall) Header ¶
func (c *MediaUploadCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MediaUploadCall) Media ¶
func (c *MediaUploadCall) Media(r io.Reader, options ...googleapi.MediaOption) *MediaUploadCall
Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.
func (*MediaUploadCall) ProgressUpdater ¶
func (c *MediaUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MediaUploadCall
ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).
func (*MediaUploadCall) ResumableMedia
deprecated
func (c *MediaUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MediaUploadCall
ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
Deprecated: use Media instead.
At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.
type OperationsCancelCall ¶
type OperationsCancelCall struct {
// contains filtered or unexported fields
}
func (*OperationsCancelCall) Context ¶
func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsCancelCall) Do ¶
func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
Do executes the "remotebuildexecution.operations.cancel" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsCancelCall) Fields ¶
func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsCancelCall) Header ¶
func (c *OperationsCancelCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OperationsDeleteCall ¶
type OperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (*OperationsDeleteCall) Context ¶
func (c *OperationsDeleteCall) Context(ctx context.Context) *OperationsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsDeleteCall) Do ¶
func (c *OperationsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error)
Do executes the "remotebuildexecution.operations.delete" call. Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsDeleteCall) Fields ¶
func (c *OperationsDeleteCall) Fields(s ...googleapi.Field) *OperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsDeleteCall) Header ¶
func (c *OperationsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type OperationsListCall ¶
type OperationsListCall struct {
// contains filtered or unexported fields
}
func (*OperationsListCall) Context ¶
func (c *OperationsListCall) Context(ctx context.Context) *OperationsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*OperationsListCall) Do ¶
func (c *OperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
Do executes the "remotebuildexecution.operations.list" call. Exactly one of *GoogleLongrunningListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*OperationsListCall) Fields ¶
func (c *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*OperationsListCall) Filter ¶
func (c *OperationsListCall) Filter(filter string) *OperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*OperationsListCall) Header ¶
func (c *OperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*OperationsListCall) IfNoneMatch ¶
func (c *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*OperationsListCall) PageSize ¶
func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*OperationsListCall) PageToken ¶
func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*OperationsListCall) Pages ¶
func (c *OperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type OperationsService ¶
type OperationsService struct {
// contains filtered or unexported fields
}
func NewOperationsService ¶
func NewOperationsService(s *Service) *OperationsService
func (*OperationsService) Cancel ¶
func (r *OperationsService) Cancel(name string, googlelongrunningcanceloperationrequest *GoogleLongrunningCancelOperationRequest) *OperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation.
The server
makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
func (*OperationsService) Delete ¶
func (r *OperationsService) Delete(name string) *OperationsDeleteCall
Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
func (*OperationsService) List ¶
func (r *OperationsService) List(name string) *OperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
type ProjectsOperationsGetCall ¶
type ProjectsOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsOperationsGetCall) Context ¶
func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ProjectsOperationsGetCall) Do ¶
func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "remotebuildexecution.projects.operations.get" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ProjectsOperationsGetCall) Fields ¶
func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsOperationsGetCall) Header ¶
func (c *ProjectsOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type ProjectsOperationsService ¶
type ProjectsOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsOperationsService ¶
func NewProjectsOperationsService(s *Service) *ProjectsOperationsService
func (*ProjectsOperationsService) Get ¶
func (r *ProjectsOperationsService) Get(name string) *ProjectsOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
type ProjectsService ¶
type ProjectsService struct { Operations *ProjectsOperationsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Media *MediaService Operations *OperationsService Projects *ProjectsService V1 *V1Service // contains filtered or unexported fields }
func New
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶
NewService creates a new Service.
type V1Service ¶
type V1Service struct {
// contains filtered or unexported fields
}
func NewV1Service ¶
func (*V1Service) Watch ¶
func (r *V1Service) Watch() *V1WatchCall
Watch: Start a streaming RPC to get watch information from the server.
type V1WatchCall ¶
type V1WatchCall struct {
// contains filtered or unexported fields
}
func (*V1WatchCall) Context ¶
func (c *V1WatchCall) Context(ctx context.Context) *V1WatchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*V1WatchCall) Do ¶
func (c *V1WatchCall) Do(opts ...googleapi.CallOption) (*GoogleWatcherV1ChangeBatch, error)
Do executes the "remotebuildexecution.watch" call. Exactly one of *GoogleWatcherV1ChangeBatch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleWatcherV1ChangeBatch.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*V1WatchCall) Fields ¶
func (c *V1WatchCall) Fields(s ...googleapi.Field) *V1WatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*V1WatchCall) Header ¶
func (c *V1WatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*V1WatchCall) IfNoneMatch ¶
func (c *V1WatchCall) IfNoneMatch(entityTag string) *V1WatchCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*V1WatchCall) ResumeMarker ¶
func (c *V1WatchCall) ResumeMarker(resumeMarker string) *V1WatchCall
ResumeMarker sets the optional parameter "resumeMarker": The `resume_marker` specifies how much of the existing underlying state is delivered to the client when the watch request is received by the system. The client can set this marker in one of the following ways to get different semantics:
- Parameter is not specified or has the value "". Semantics: Fetch initial state. The client wants the entity's initial state to be delivered. See
the
description in "Initial State".
- Parameter is set to the string "now" (UTF-8 encoding). Semantics: Fetch new changes only. The client just wants to get the changes received by the system
after
the watch point. The system may deliver changes from before the
watch
point as well.
- Parameter is set to a value received in an earlier `Change.resume_marker` field while watching the same entity. Semantics: Resume from a specific point. The client wants to receive the changes from a specific point;
this
value must correspond to a value received in the
`Change.resume_marker`
field. The system may deliver changes from before the
`resume_marker`
as well. If the system cannot resume the stream from this point
(e.g.,
if it is too far behind in the stream), it can raise the `FAILED_PRECONDITION` error.
An implementation MUST support an unspecified parameter and the empty string "" marker (initial state fetching) and the "now" marker. It need not support resuming from a specific point.
func (*V1WatchCall) Target ¶
func (c *V1WatchCall) Target(target string) *V1WatchCall
Target sets the optional parameter "target": The `target` value **must** be a valid URL path pointing to an entity to watch. Note that the service name **must** be removed from the target field (e.g., the target field must say "/foo/bar", not "myservice.googleapis.com/foo/bar"). A client is also allowed to pass system-specific parameters in the URL that are only obeyed by some implementations. Some parameters will be implementation-specific. However, some have predefined meaning and are listed here:
- recursive = true|false [default=false] If set to true, indicates that the client wants to watch all
elements
of entities in the subtree rooted at the entity's name in
`target`. For
descendants that are not the immediate children of the target,
the
`Change.element` will contain slashes. Note that some namespaces and entities will not support recursive watching. When watching such an entity, a client must not set
recursive
to true. Otherwise, it will receive an `UNIMPLEMENTED`
error.
Normal URL encoding must be used inside `target`. For example, if a query parameter name or value, or the non-query parameter portion of `target` contains a special character, it must be %-encoded. We recommend that clients and servers use their runtime's URL library to produce and consume target values.