Class ContextRule.Builder (2.46.0)

Version 2.46.0

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public static final class ContextRule.Builder extends GeneratedMessageV3.Builder<ContextRule.Builder> implements ContextRuleOrBuilder

A context rule provides information about the context for an individual API element.

Protobuf type google.api.ContextRule

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ContextRule.Builder

Implements

ContextRuleOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllAllowedRequestExtensions(Iterable<String> values)

public ContextRule.Builder addAllAllowedRequestExtensions(Iterable<String> values)

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

repeated string allowed_request_extensions = 4;

Parameter
Name	Description
values	Iterable<String> The allowedRequestExtensions to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addAllAllowedResponseExtensions(Iterable<String> values)

public ContextRule.Builder addAllAllowedResponseExtensions(Iterable<String> values)

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

repeated string allowed_response_extensions = 5;

Parameter
Name	Description
values	Iterable<String> The allowedResponseExtensions to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addAllProvided(Iterable<String> values)

public ContextRule.Builder addAllProvided(Iterable<String> values)

A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.

repeated string provided = 3;

Parameter
Name	Description
values	Iterable<String> The provided to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addAllRequested(Iterable<String> values)

public ContextRule.Builder addAllRequested(Iterable<String> values)

A list of full type names of requested contexts, only the requested context will be made available to the backend.

repeated string requested = 2;

Parameter
Name	Description
values	Iterable<String> The requested to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addAllowedRequestExtensions(String value)

public ContextRule.Builder addAllowedRequestExtensions(String value)

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

repeated string allowed_request_extensions = 4;

Parameter
Name	Description
value	String The allowedRequestExtensions to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addAllowedRequestExtensionsBytes(ByteString value)

public ContextRule.Builder addAllowedRequestExtensionsBytes(ByteString value)

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

repeated string allowed_request_extensions = 4;

Parameter
Name	Description
value	ByteString The bytes of the allowedRequestExtensions to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addAllowedResponseExtensions(String value)

public ContextRule.Builder addAllowedResponseExtensions(String value)

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

repeated string allowed_response_extensions = 5;

Parameter
Name	Description
value	String The allowedResponseExtensions to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addAllowedResponseExtensionsBytes(ByteString value)

public ContextRule.Builder addAllowedResponseExtensionsBytes(ByteString value)

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

repeated string allowed_response_extensions = 5;

Parameter
Name	Description
value	ByteString The bytes of the allowedResponseExtensions to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addProvided(String value)

public ContextRule.Builder addProvided(String value)

A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.

repeated string provided = 3;

Parameter
Name	Description
value	String The provided to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addProvidedBytes(ByteString value)

public ContextRule.Builder addProvidedBytes(ByteString value)

A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.

repeated string provided = 3;

Parameter
Name	Description
value	ByteString The bytes of the provided to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ContextRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ContextRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addRequested(String value)

public ContextRule.Builder addRequested(String value)

A list of full type names of requested contexts, only the requested context will be made available to the backend.

repeated string requested = 2;

Parameter
Name	Description
value	String The requested to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

addRequestedBytes(ByteString value)

public ContextRule.Builder addRequestedBytes(ByteString value)

A list of full type names of requested contexts, only the requested context will be made available to the backend.

repeated string requested = 2;

Parameter
Name	Description
value	ByteString The bytes of the requested to add.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

build()

public ContextRule build()

Returns
Type	Description
ContextRule

buildPartial()

public ContextRule buildPartial()

Returns
Type	Description
ContextRule

clear()

public ContextRule.Builder clear()

Returns
Type	Description
ContextRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAllowedRequestExtensions()

public ContextRule.Builder clearAllowedRequestExtensions()

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

repeated string allowed_request_extensions = 4;

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

clearAllowedResponseExtensions()

public ContextRule.Builder clearAllowedResponseExtensions()

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

repeated string allowed_response_extensions = 5;

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ContextRule.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ContextRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public ContextRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ContextRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProvided()

public ContextRule.Builder clearProvided()

A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.

repeated string provided = 3;

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

clearRequested()

public ContextRule.Builder clearRequested()

A list of full type names of requested contexts, only the requested context will be made available to the backend.

repeated string requested = 2;

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

clearSelector()

public ContextRule.Builder clearSelector()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

clone()

public ContextRule.Builder clone()

Returns
Type	Description
ContextRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAllowedRequestExtensions(int index)

public String getAllowedRequestExtensions(int index)

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

repeated string allowed_request_extensions = 4;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The allowedRequestExtensions at the given index.

getAllowedRequestExtensionsBytes(int index)

public ByteString getAllowedRequestExtensionsBytes(int index)

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

repeated string allowed_request_extensions = 4;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the allowedRequestExtensions at the given index.

getAllowedRequestExtensionsCount()

public int getAllowedRequestExtensionsCount()

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

repeated string allowed_request_extensions = 4;

Returns
Type	Description
int	The count of allowedRequestExtensions.

getAllowedRequestExtensionsList()

public ProtocolStringList getAllowedRequestExtensionsList()

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

repeated string allowed_request_extensions = 4;

Returns
Type	Description
ProtocolStringList	A list containing the allowedRequestExtensions.

getAllowedResponseExtensions(int index)

public String getAllowedResponseExtensions(int index)

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

repeated string allowed_response_extensions = 5;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The allowedResponseExtensions at the given index.

getAllowedResponseExtensionsBytes(int index)

public ByteString getAllowedResponseExtensionsBytes(int index)

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

repeated string allowed_response_extensions = 5;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the allowedResponseExtensions at the given index.

getAllowedResponseExtensionsCount()

public int getAllowedResponseExtensionsCount()

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

repeated string allowed_response_extensions = 5;

Returns
Type	Description
int	The count of allowedResponseExtensions.

getAllowedResponseExtensionsList()

public ProtocolStringList getAllowedResponseExtensionsList()

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

repeated string allowed_response_extensions = 5;

Returns
Type	Description
ProtocolStringList	A list containing the allowedResponseExtensions.

getDefaultInstanceForType()

public ContextRule getDefaultInstanceForType()

Returns
Type	Description
ContextRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getProvided(int index)

public String getProvided(int index)

A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.

repeated string provided = 3;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The provided at the given index.

getProvidedBytes(int index)

public ByteString getProvidedBytes(int index)

A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.

repeated string provided = 3;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the provided at the given index.

getProvidedCount()

public int getProvidedCount()

A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.

repeated string provided = 3;

Returns
Type	Description
int	The count of provided.

getProvidedList()

public ProtocolStringList getProvidedList()

A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.

repeated string provided = 3;

Returns
Type	Description
ProtocolStringList	A list containing the provided.

getRequested(int index)

public String getRequested(int index)

A list of full type names of requested contexts, only the requested context will be made available to the backend.

repeated string requested = 2;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The requested at the given index.

getRequestedBytes(int index)

public ByteString getRequestedBytes(int index)

A list of full type names of requested contexts, only the requested context will be made available to the backend.

repeated string requested = 2;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the requested at the given index.

getRequestedCount()

public int getRequestedCount()

A list of full type names of requested contexts, only the requested context will be made available to the backend.

repeated string requested = 2;

Returns
Type	Description
int	The count of requested.

getRequestedList()

public ProtocolStringList getRequestedList()

A list of full type names of requested contexts, only the requested context will be made available to the backend.

repeated string requested = 2;

Returns
Type	Description
ProtocolStringList	A list containing the requested.

getSelector()

public String getSelector()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
String	The selector.

getSelectorBytes()

public ByteString getSelectorBytes()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
ByteString	The bytes for selector.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ContextRule other)

public ContextRule.Builder mergeFrom(ContextRule other)

Parameter
Name	Description
other	ContextRule

Returns
Type	Description
ContextRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ContextRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ContextRule.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ContextRule.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ContextRule.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ContextRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ContextRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAllowedRequestExtensions(int index, String value)

public ContextRule.Builder setAllowedRequestExtensions(int index, String value)

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

repeated string allowed_request_extensions = 4;

Parameters
Name	Description
index	int The index to set the value at.
value	String The allowedRequestExtensions to set.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

setAllowedResponseExtensions(int index, String value)

public ContextRule.Builder setAllowedResponseExtensions(int index, String value)

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

repeated string allowed_response_extensions = 5;

Parameters
Name	Description
index	int The index to set the value at.
value	String The allowedResponseExtensions to set.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ContextRule.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ContextRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setProvided(int index, String value)

public ContextRule.Builder setProvided(int index, String value)

A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.

repeated string provided = 3;

Parameters
Name	Description
index	int The index to set the value at.
value	String The provided to set.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ContextRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ContextRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRequested(int index, String value)

public ContextRule.Builder setRequested(int index, String value)

A list of full type names of requested contexts, only the requested context will be made available to the backend.

repeated string requested = 2;

Parameters
Name	Description
index	int The index to set the value at.
value	String The requested to set.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

setSelector(String value)

public ContextRule.Builder setSelector(String value)

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Parameter
Name	Description
value	String The selector to set.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

setSelectorBytes(ByteString value)

public ContextRule.Builder setSelectorBytes(ByteString value)

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Parameter
Name	Description
value	ByteString The bytes for selector to set.

Returns
Type	Description
ContextRule.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ContextRule.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ContextRule.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)