Class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputFile

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

Overview

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.

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) ⇒ BuildBazelRemoteExecutionV2OutputFile

Returns a new instance of BuildBazelRemoteExecutionV2OutputFile.



1254
1255
1256
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 1254

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

Instance Attribute Details

#contentsString

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

Returns:

  • (String)


1204
1205
1206
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 1204

def contents
  @contents
end

#digestGoogle::Apis::RemotebuildexecutionV1::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. 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


1234
1235
1236
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 1234

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)


1239
1240
1241
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 1239

def is_executable
  @is_executable
end

#node_propertiesArray<Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty>

The supported node properties of the OutputFile, if requested by the Action. Corresponds to the JSON property nodeProperties



1245
1246
1247
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 1245

def node_properties
  @node_properties
end

#pathString

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

Returns:

  • (String)


1252
1253
1254
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 1252

def path
  @path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1259
1260
1261
1262
1263
1264
1265
# File 'generated/google/apis/remotebuildexecution_v1/classes.rb', line 1259

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