Class RequestOptions.ClientContext (6.108.0)

Version latest

• 6.108.0 (latest)
• 6.107.0
• 6.103.0
• 6.102.1
• 6.101.1
• 6.100.0
• 6.99.0
• 6.98.1
• 6.97.1
• 6.96.1
• 6.95.1
• 6.94.0
• 6.93.0
• 6.89.0
• 6.88.0
• 6.87.0
• 6.86.0
• 6.85.0
• 6.83.0
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public static final class RequestOptions.ClientContext extends GeneratedMessage implements RequestOptions.ClientContextOrBuilder

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

Protobuf type google.spanner.v1.RequestOptions.ClientContext

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > RequestOptions.ClientContext

Implements

RequestOptions.ClientContextOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

SECURE_CONTEXT_FIELD_NUMBER

public static final int SECURE_CONTEXT_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static RequestOptions.ClientContext getDefaultInstance()

Returns
Type	Description
RequestOptions.ClientContext

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static RequestOptions.ClientContext.Builder newBuilder()

Returns
Type	Description
RequestOptions.ClientContext.Builder

newBuilder(RequestOptions.ClientContext prototype)

public static RequestOptions.ClientContext.Builder newBuilder(RequestOptions.ClientContext prototype)

Parameter
Name	Description
prototype	RequestOptions.ClientContext

Returns
Type	Description
RequestOptions.ClientContext.Builder

parseDelimitedFrom(InputStream input)

public static RequestOptions.ClientContext parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestOptions.ClientContext parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static RequestOptions.ClientContext parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RequestOptions.ClientContext parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RequestOptions.ClientContext parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RequestOptions.ClientContext parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RequestOptions.ClientContext parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestOptions.ClientContext parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static RequestOptions.ClientContext parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RequestOptions.ClientContext parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static RequestOptions.ClientContext parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RequestOptions.ClientContext parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RequestOptions.ClientContext

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<RequestOptions.ClientContext> parser()

Returns
Type	Description
Parser<ClientContext>

Methods

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

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public RequestOptions.ClientContext getDefaultInstanceForType()

Returns
Type	Description
RequestOptions.ClientContext

getParserForType()

public Parser<RequestOptions.ClientContext> getParserForType()

Returns
Type	Description
Parser<ClientContext>

Overrides

GeneratedMessage.getParserForType()

getSecureContext() (deprecated)

public Map<String,Value> getSecureContext()

Use #getSecureContextMap() instead.

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

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public RequestOptions.ClientContext.Builder newBuilderForType()

Returns
Type	Description
RequestOptions.ClientContext.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RequestOptions.ClientContext.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
RequestOptions.ClientContext.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public RequestOptions.ClientContext.Builder toBuilder()

Returns
Type	Description
RequestOptions.ClientContext.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException