Class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2RequestMetadata

Inherits:

Object

• Object
• Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2RequestMetadata

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/remotebuildexecution_v1alpha/classes.rb,
lib/google/apis/remotebuildexecution_v1alpha/representations.rb,
lib/google/apis/remotebuildexecution_v1alpha/representations.rb

Overview

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# requests). 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.

Instance Attribute Summary

• #action_id ⇒ String

  An identifier that ties multiple requests to the same action.

• #action_mnemonic ⇒ String

  A brief description of the kind of action, for example, CppCompile or GoLink.

• #configuration_id ⇒ String

  An identifier for the configuration in which the target was built, e.g.

• #correlated_invocations_id ⇒ String

  An identifier to tie multiple tool invocations together.

• #target_id ⇒ String

  An identifier for the target which produced this action.

• #tool_details ⇒ Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2ToolDetails

  Details for the tool used to call the API.

• #tool_invocation_id ⇒ String

  An identifier that ties multiple actions together to a final result.

Instance Method Summary

• #initialize(**args) ⇒ BuildBazelRemoteExecutionV2RequestMetadata constructor

  A new instance of BuildBazelRemoteExecutionV2RequestMetadata.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ BuildBazelRemoteExecutionV2RequestMetadata

Returns a new instance of BuildBazelRemoteExecutionV2RequestMetadata.

# File 'lib/google/apis/remotebuildexecution_v1alpha/classes.rb', line 1339

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

Instance Attribute Details

#action_id ⇒ String

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

Returns:

• (String)

# File 'lib/google/apis/remotebuildexecution_v1alpha/classes.rb', line 1299

def action_id
  @action_id
end

#action_mnemonic ⇒ String

A brief description of the kind of action, for example, CppCompile or GoLink. There is no standard agreed set of values for this, and they are expected to vary between different client tools. Corresponds to the JSON property actionMnemonic

Returns:

• (String)

# File 'lib/google/apis/remotebuildexecution_v1alpha/classes.rb', line 1306

def action_mnemonic
  @action_mnemonic
end

#configuration_id ⇒ String

An identifier for the configuration in which the target was built, e.g. for differentiating building host tools or different target platforms. There is no expectation that this value will have any particular structure, or equality across invocations, though some client tools may offer these guarantees. Corresponds to the JSON property configurationId

Returns:

• (String)

# File 'lib/google/apis/remotebuildexecution_v1alpha/classes.rb', line 1314

def configuration_id
  @configuration_id
end

#correlated_invocations_id ⇒ String

An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch. Corresponds to the JSON property correlatedInvocationsId

Returns:

• (String)

# File 'lib/google/apis/remotebuildexecution_v1alpha/classes.rb', line 1320

def correlated_invocations_id
  @correlated_invocations_id
end

#target_id ⇒ String

An identifier for the target which produced this action. No guarantees are made around how many actions may relate to a single target. Corresponds to the JSON property targetId

Returns:

• (String)

# File 'lib/google/apis/remotebuildexecution_v1alpha/classes.rb', line 1326

def target_id
  @target_id
end

#tool_details ⇒ Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2ToolDetails

Details for the tool used to call the API. Corresponds to the JSON property toolDetails

Returns:

• (Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2ToolDetails)

# File 'lib/google/apis/remotebuildexecution_v1alpha/classes.rb', line 1331

def tool_details
  @tool_details
end

#tool_invocation_id ⇒ String

An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test. Corresponds to the JSON property toolInvocationId

Returns:

• (String)

# File 'lib/google/apis/remotebuildexecution_v1alpha/classes.rb', line 1337

def tool_invocation_id
  @tool_invocation_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/remotebuildexecution_v1alpha/classes.rb', line 1344

def update!(**args)
  @action_id = args[:action_id] if args.key?(:action_id)
  @action_mnemonic = args[:action_mnemonic] if args.key?(:action_mnemonic)
  @configuration_id = args[:configuration_id] if args.key?(:configuration_id)
  @correlated_invocations_id = args[:correlated_invocations_id] if args.key?(:correlated_invocations_id)
  @target_id = args[:target_id] if args.key?(:target_id)
  @tool_details = args[:tool_details] if args.key?(:tool_details)
  @tool_invocation_id = args[:tool_invocation_id] if args.key?(:tool_invocation_id)
end