Class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2RequestMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/remotebuildexecution_v2/classes.rb,
lib/google/apis/remotebuildexecution_v2/representations.rb,
lib/google/apis/remotebuildexecution_v2/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 collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BuildBazelRemoteExecutionV2RequestMetadata

Returns a new instance of BuildBazelRemoteExecutionV2RequestMetadata.


1902
1903
1904
# File 'lib/google/apis/remotebuildexecution_v2/classes.rb', line 1902

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

Instance Attribute Details

#action_idString

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)

1862
1863
1864
# File 'lib/google/apis/remotebuildexecution_v2/classes.rb', line 1862

def action_id
  @action_id
end

#action_mnemonicString

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)

1869
1870
1871
# File 'lib/google/apis/remotebuildexecution_v2/classes.rb', line 1869

def action_mnemonic
  @action_mnemonic
end

#configuration_idString

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)

1877
1878
1879
# File 'lib/google/apis/remotebuildexecution_v2/classes.rb', line 1877

def configuration_id
  @configuration_id
end

#correlated_invocations_idString

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)

1883
1884
1885
# File 'lib/google/apis/remotebuildexecution_v2/classes.rb', line 1883

def correlated_invocations_id
  @correlated_invocations_id
end

#target_idString

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)

1889
1890
1891
# File 'lib/google/apis/remotebuildexecution_v2/classes.rb', line 1889

def target_id
  @target_id
end

#tool_detailsGoogle::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ToolDetails

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


1894
1895
1896
# File 'lib/google/apis/remotebuildexecution_v2/classes.rb', line 1894

def tool_details
  @tool_details
end

#tool_invocation_idString

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)

1900
1901
1902
# File 'lib/google/apis/remotebuildexecution_v2/classes.rb', line 1900

def tool_invocation_id
  @tool_invocation_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1907
1908
1909
1910
1911
1912
1913
1914
1915
# File 'lib/google/apis/remotebuildexecution_v2/classes.rb', line 1907

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