Class RequestOptions.ClientContext.Builder (6.108.0)

public static final class RequestOptions.ClientContext.Builder extends GeneratedMessage.Builder<RequestOptions.ClientContext.Builder> implements RequestOptions.ClientContextOrBuilder

Container for various pieces of client-owned context attached to a request.

Protobuf type google.spanner.v1.RequestOptions.ClientContext

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public RequestOptions.ClientContext build()
Returns
Type Description
RequestOptions.ClientContext

buildPartial()

public RequestOptions.ClientContext buildPartial()
Returns
Type Description
RequestOptions.ClientContext

clear()

public RequestOptions.ClientContext.Builder clear()
Returns
Type Description
RequestOptions.ClientContext.Builder
Overrides

clearSecureContext()

public RequestOptions.ClientContext.Builder clearSecureContext()
Returns
Type Description
RequestOptions.ClientContext.Builder

containsSecureContext(String key)

public boolean containsSecureContext(String key)

Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).

map<string, .google.protobuf.Value> secure_context = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public RequestOptions.ClientContext getDefaultInstanceForType()
Returns
Type Description
RequestOptions.ClientContext

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableSecureContext() (deprecated)

public Map<String,Value> getMutableSecureContext()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Value>

getSecureContext() (deprecated)

public Map<String,Value> getSecureContext()
Returns
Type Description
Map<String,Value>

getSecureContextCount()

public int getSecureContextCount()

Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).

map<string, .google.protobuf.Value> secure_context = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSecureContextMap()

public Map<String,Value> getSecureContextMap()

Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).

map<string, .google.protobuf.Value> secure_context = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,Value>

getSecureContextOrDefault(String key, Value defaultValue)

public Value getSecureContextOrDefault(String key, Value defaultValue)

Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).

map<string, .google.protobuf.Value> secure_context = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getSecureContextOrThrow(String key)

public Value getSecureContextOrThrow(String key)

Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).

map<string, .google.protobuf.Value> secure_context = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Value

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RequestOptions.ClientContext.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestOptions.ClientContext.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RequestOptions.ClientContext.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RequestOptions.ClientContext.Builder
Overrides

mergeFrom(RequestOptions.ClientContext other)

public RequestOptions.ClientContext.Builder mergeFrom(RequestOptions.ClientContext other)
Parameter
Name Description
other RequestOptions.ClientContext
Returns
Type Description
RequestOptions.ClientContext.Builder

putAllSecureContext(Map<String,Value> values)

public RequestOptions.ClientContext.Builder putAllSecureContext(Map<String,Value> values)

Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).

map<string, .google.protobuf.Value> secure_context = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,Value>
Returns
Type Description
RequestOptions.ClientContext.Builder

putSecureContext(String key, Value value)

public RequestOptions.ClientContext.Builder putSecureContext(String key, Value value)

Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).

map<string, .google.protobuf.Value> secure_context = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value Value
Returns
Type Description
RequestOptions.ClientContext.Builder

putSecureContextBuilderIfAbsent(String key)

public Value.Builder putSecureContextBuilderIfAbsent(String key)

Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).

map<string, .google.protobuf.Value> secure_context = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Builder

removeSecureContext(String key)

public RequestOptions.ClientContext.Builder removeSecureContext(String key)

Optional. Map of parameter name to value for this request. These values will be returned by any SECURE_CONTEXT() calls invoked by this request (e.g., by queries against Parameterized Secure Views).

map<string, .google.protobuf.Value> secure_context = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
RequestOptions.ClientContext.Builder