Class ContextRule.Builder (2.8.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The allowedRequestExtensions to add.

Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The allowedResponseExtensions to add.

Returns
TypeDescription
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.

repeated string provided = 3;

Parameter
NameDescription
valuesIterable<String>

The provided to add.

Returns
TypeDescription
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.

repeated string requested = 2;

Parameter
NameDescription
valuesIterable<String>

The requested to add.

Returns
TypeDescription
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
NameDescription
valueString

The allowedRequestExtensions to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the allowedRequestExtensions to add.

Returns
TypeDescription
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
NameDescription
valueString

The allowedResponseExtensions to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the allowedResponseExtensions to add.

Returns
TypeDescription
ContextRule.Builder

This builder for chaining.

addProvided(String value)

public ContextRule.Builder addProvided(String value)

A list of full type names of provided contexts.

repeated string provided = 3;

Parameter
NameDescription
valueString

The provided to add.

Returns
TypeDescription
ContextRule.Builder

This builder for chaining.

addProvidedBytes(ByteString value)

public ContextRule.Builder addProvidedBytes(ByteString value)

A list of full type names of provided contexts.

repeated string provided = 3;

Parameter
NameDescription
valueByteString

The bytes of the provided to add.

Returns
TypeDescription
ContextRule.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ContextRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ContextRule.Builder
Overrides

addRequested(String value)

public ContextRule.Builder addRequested(String value)

A list of full type names of requested contexts.

repeated string requested = 2;

Parameter
NameDescription
valueString

The requested to add.

Returns
TypeDescription
ContextRule.Builder

This builder for chaining.

addRequestedBytes(ByteString value)

public ContextRule.Builder addRequestedBytes(ByteString value)

A list of full type names of requested contexts.

repeated string requested = 2;

Parameter
NameDescription
valueByteString

The bytes of the requested to add.

Returns
TypeDescription
ContextRule.Builder

This builder for chaining.

build()

public ContextRule build()
Returns
TypeDescription
ContextRule

buildPartial()

public ContextRule buildPartial()
Returns
TypeDescription
ContextRule

clear()

public ContextRule.Builder clear()
Returns
TypeDescription
ContextRule.Builder
Overrides

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
TypeDescription
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
TypeDescription
ContextRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ContextRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ContextRule.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ContextRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ContextRule.Builder
Overrides

clearProvided()

public ContextRule.Builder clearProvided()

A list of full type names of provided contexts.

repeated string provided = 3;

Returns
TypeDescription
ContextRule.Builder

This builder for chaining.

clearRequested()

public ContextRule.Builder clearRequested()

A list of full type names of requested contexts.

repeated string requested = 2;

Returns
TypeDescription
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
TypeDescription
ContextRule.Builder

This builder for chaining.

clone()

public ContextRule.Builder clone()
Returns
TypeDescription
ContextRule.Builder
Overrides

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the allowedResponseExtensions.

getDefaultInstanceForType()

public ContextRule getDefaultInstanceForType()
Returns
TypeDescription
ContextRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getProvided(int index)

public String getProvided(int index)

A list of full type names of provided contexts.

repeated string provided = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The provided at the given index.

getProvidedBytes(int index)

public ByteString getProvidedBytes(int index)

A list of full type names of provided contexts.

repeated string provided = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the provided at the given index.

getProvidedCount()

public int getProvidedCount()

A list of full type names of provided contexts.

repeated string provided = 3;

Returns
TypeDescription
int

The count of provided.

getProvidedList()

public ProtocolStringList getProvidedList()

A list of full type names of provided contexts.

repeated string provided = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the provided.

getRequested(int index)

public String getRequested(int index)

A list of full type names of requested contexts.

repeated string requested = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The requested at the given index.

getRequestedBytes(int index)

public ByteString getRequestedBytes(int index)

A list of full type names of requested contexts.

repeated string requested = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the requested at the given index.

getRequestedCount()

public int getRequestedCount()

A list of full type names of requested contexts.

repeated string requested = 2;

Returns
TypeDescription
int

The count of requested.

getRequestedList()

public ProtocolStringList getRequestedList()

A list of full type names of requested contexts.

repeated string requested = 2;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for selector.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ContextRule other)

public ContextRule.Builder mergeFrom(ContextRule other)
Parameter
NameDescription
otherContextRule
Returns
TypeDescription
ContextRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ContextRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ContextRule.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ContextRule.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ContextRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ContextRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ContextRule.Builder
Overrides

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
NameDescription
indexint

The index to set the value at.

valueString

The allowedRequestExtensions to set.

Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The allowedResponseExtensions to set.

Returns
TypeDescription
ContextRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ContextRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ContextRule.Builder
Overrides

setProvided(int index, String value)

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

A list of full type names of provided contexts.

repeated string provided = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The provided to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ContextRule.Builder
Overrides

setRequested(int index, String value)

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

A list of full type names of requested contexts.

repeated string requested = 2;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The requested to set.

Returns
TypeDescription
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
NameDescription
valueString

The selector to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for selector to set.

Returns
TypeDescription
ContextRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ContextRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ContextRule.Builder
Overrides