Class ContextRule (2.9.1)

public final class ContextRule extends GeneratedMessageV3 implements ContextRuleOrBuilder

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

Protobuf type google.api.ContextRule

Static Fields

ALLOWED_REQUEST_EXTENSIONS_FIELD_NUMBER

public static final int ALLOWED_REQUEST_EXTENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

ALLOWED_RESPONSE_EXTENSIONS_FIELD_NUMBER

public static final int ALLOWED_RESPONSE_EXTENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

PROVIDED_FIELD_NUMBER

public static final int PROVIDED_FIELD_NUMBER
Field Value
TypeDescription
int

REQUESTED_FIELD_NUMBER

public static final int REQUESTED_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTOR_FIELD_NUMBER

public static final int SELECTOR_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ContextRule getDefaultInstance()
Returns
TypeDescription
ContextRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ContextRule.Builder newBuilder()
Returns
TypeDescription
ContextRule.Builder

newBuilder(ContextRule prototype)

public static ContextRule.Builder newBuilder(ContextRule prototype)
Parameter
NameDescription
prototypeContextRule
Returns
TypeDescription
ContextRule.Builder

parseDelimitedFrom(InputStream input)

public static ContextRule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ContextRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ContextRule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ContextRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ContextRule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ContextRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ContextRule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ContextRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ContextRule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ContextRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ContextRule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ContextRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ContextRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ContextRule> parser()
Returns
TypeDescription
Parser<ContextRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

getParserForType()

public Parser<ContextRule> getParserForType()
Returns
TypeDescription
Parser<ContextRule>
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ContextRule.Builder newBuilderForType()
Returns
TypeDescription
ContextRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ContextRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ContextRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ContextRule.Builder toBuilder()
Returns
TypeDescription
ContextRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException