Class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteexecutionV1testOutputFile

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/remotebuildexecution_v1alpha/classes.rb,
generated/google/apis/remotebuildexecution_v1alpha/representations.rb,
generated/google/apis/remotebuildexecution_v1alpha/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleDevtoolsRemoteexecutionV1testOutputFile

Returns a new instance of GoogleDevtoolsRemoteexecutionV1testOutputFile



2879
2880
2881
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2879

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#contentString

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. Corresponds to the JSON property content NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


2833
2834
2835
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2833

def content
  @content
end

#digestGoogle::Apis::RemotebuildexecutionV1alpha::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. Corresponds to the JSON property digest


2864
2865
2866
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2864

def digest
  @digest
end

#is_executableBoolean Also known as: is_executable?

True if file is executable, false otherwise. Corresponds to the JSON property isExecutable

Returns:

  • (Boolean)


2869
2870
2871
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2869

def is_executable
  @is_executable
end

#pathString

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. Corresponds to the JSON property path

Returns:

  • (String)


2877
2878
2879
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2877

def path
  @path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2884
2885
2886
2887
2888
2889
# File 'generated/google/apis/remotebuildexecution_v1alpha/classes.rb', line 2884

def update!(**args)
  @content = args[:content] if args.key?(:content)
  @digest = args[:digest] if args.key?(:digest)
  @is_executable = args[:is_executable] if args.key?(:is_executable)
  @path = args[:path] if args.key?(:path)
end