Class AttributeContext
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- io.envoyproxy.envoy.service.auth.v3.AttributeContext
-
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,AttributeContextOrBuilder,Serializable
public final class AttributeContext extends com.google.protobuf.GeneratedMessageV3 implements AttributeContextOrBuilder
An attribute is a piece of metadata that describes an activity on a network. For example, the size of an HTTP request, or the status code of an HTTP response. Each attribute has a type and a name, which is logically defined as a proto message field of the ``AttributeContext``. The ``AttributeContext`` is a collection of individual attributes supported by Envoy authorization system. [#comment: The following items are left out of this proto Request.Auth field for jwt tokens Request.Api for api management Origin peer that originated the request Caching Protocol request_context return values to inject back into the filter chain peer.claims -- from X.509 extensions Configuration - field mask to send - which return values from request_context are copied back - which return values are copied into request_headers] [#next-free-field: 12]
Protobuf typeenvoy.service.auth.v3.AttributeContext- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAttributeContext.BuilderAn attribute is a piece of metadata that describes an activity on a network.static classAttributeContext.HttpRequestThis message defines attributes for an HTTP request.static interfaceAttributeContext.HttpRequestOrBuilderstatic classAttributeContext.PeerThis message defines attributes for a node that handles a network request.static interfaceAttributeContext.PeerOrBuilderstatic classAttributeContext.RequestRepresents a network request, such as an HTTP request.static interfaceAttributeContext.RequestOrBuilder-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intCONTEXT_EXTENSIONS_FIELD_NUMBERstatic intDESTINATION_FIELD_NUMBERstatic intMETADATA_CONTEXT_FIELD_NUMBERstatic intREQUEST_FIELD_NUMBERstatic intSOURCE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsContextExtensions(String key)This is analogous to http_request.headers, however these contents will not be sent to the upstream server.booleanequals(Object obj)Map<String,String>getContextExtensions()Deprecated.intgetContextExtensionsCount()This is analogous to http_request.headers, however these contents will not be sent to the upstream server.Map<String,String>getContextExtensionsMap()This is analogous to http_request.headers, however these contents will not be sent to the upstream server.StringgetContextExtensionsOrDefault(String key, String defaultValue)This is analogous to http_request.headers, however these contents will not be sent to the upstream server.StringgetContextExtensionsOrThrow(String key)This is analogous to http_request.headers, however these contents will not be sent to the upstream server.static AttributeContextgetDefaultInstance()AttributeContextgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()AttributeContext.PeergetDestination()The destination of a network activity, such as accepting a TCP connection.AttributeContext.PeerOrBuildergetDestinationOrBuilder()The destination of a network activity, such as accepting a TCP connection.MetadatagetMetadataContext()Dynamic metadata associated with the request.MetadataOrBuildergetMetadataContextOrBuilder()Dynamic metadata associated with the request.com.google.protobuf.Parser<AttributeContext>getParserForType()AttributeContext.RequestgetRequest()Represents a network request, such as an HTTP request.AttributeContext.RequestOrBuildergetRequestOrBuilder()Represents a network request, such as an HTTP request.intgetSerializedSize()AttributeContext.PeergetSource()The source of a network activity, such as starting a TCP connection.AttributeContext.PeerOrBuildergetSourceOrBuilder()The source of a network activity, such as starting a TCP connection.com.google.protobuf.UnknownFieldSetgetUnknownFields()booleanhasDestination()The destination of a network activity, such as accepting a TCP connection.inthashCode()booleanhasMetadataContext()Dynamic metadata associated with the request.booleanhasRequest()Represents a network request, such as an HTTP request.booleanhasSource()The source of a network activity, such as starting a TCP connection.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static AttributeContext.BuildernewBuilder()static AttributeContext.BuildernewBuilder(AttributeContext prototype)AttributeContext.BuildernewBuilderForType()protected AttributeContext.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static AttributeContextparseDelimitedFrom(InputStream input)static AttributeContextparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static AttributeContextparseFrom(byte[] data)static AttributeContextparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static AttributeContextparseFrom(com.google.protobuf.ByteString data)static AttributeContextparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static AttributeContextparseFrom(com.google.protobuf.CodedInputStream input)static AttributeContextparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static AttributeContextparseFrom(InputStream input)static AttributeContextparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static AttributeContextparseFrom(ByteBuffer data)static AttributeContextparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<AttributeContext>parser()AttributeContext.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
SOURCE_FIELD_NUMBER
public static final int SOURCE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESTINATION_FIELD_NUMBER
public static final int DESTINATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
REQUEST_FIELD_NUMBER
public static final int REQUEST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONTEXT_EXTENSIONS_FIELD_NUMBER
public static final int CONTEXT_EXTENSIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
METADATA_CONTEXT_FIELD_NUMBER
public static final int METADATA_CONTEXT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasSource
public boolean hasSource()
The source of a network activity, such as starting a TCP connection. In a multi hop network activity, the source represents the sender of the last hop.
.envoy.service.auth.v3.AttributeContext.Peer source = 1;- Specified by:
hasSourcein interfaceAttributeContextOrBuilder- Returns:
- Whether the source field is set.
-
getSource
public AttributeContext.Peer getSource()
The source of a network activity, such as starting a TCP connection. In a multi hop network activity, the source represents the sender of the last hop.
.envoy.service.auth.v3.AttributeContext.Peer source = 1;- Specified by:
getSourcein interfaceAttributeContextOrBuilder- Returns:
- The source.
-
getSourceOrBuilder
public AttributeContext.PeerOrBuilder getSourceOrBuilder()
The source of a network activity, such as starting a TCP connection. In a multi hop network activity, the source represents the sender of the last hop.
.envoy.service.auth.v3.AttributeContext.Peer source = 1;- Specified by:
getSourceOrBuilderin interfaceAttributeContextOrBuilder
-
hasDestination
public boolean hasDestination()
The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop.
.envoy.service.auth.v3.AttributeContext.Peer destination = 2;- Specified by:
hasDestinationin interfaceAttributeContextOrBuilder- Returns:
- Whether the destination field is set.
-
getDestination
public AttributeContext.Peer getDestination()
The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop.
.envoy.service.auth.v3.AttributeContext.Peer destination = 2;- Specified by:
getDestinationin interfaceAttributeContextOrBuilder- Returns:
- The destination.
-
getDestinationOrBuilder
public AttributeContext.PeerOrBuilder getDestinationOrBuilder()
The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop.
.envoy.service.auth.v3.AttributeContext.Peer destination = 2;- Specified by:
getDestinationOrBuilderin interfaceAttributeContextOrBuilder
-
hasRequest
public boolean hasRequest()
Represents a network request, such as an HTTP request.
.envoy.service.auth.v3.AttributeContext.Request request = 4;- Specified by:
hasRequestin interfaceAttributeContextOrBuilder- Returns:
- Whether the request field is set.
-
getRequest
public AttributeContext.Request getRequest()
Represents a network request, such as an HTTP request.
.envoy.service.auth.v3.AttributeContext.Request request = 4;- Specified by:
getRequestin interfaceAttributeContextOrBuilder- Returns:
- The request.
-
getRequestOrBuilder
public AttributeContext.RequestOrBuilder getRequestOrBuilder()
Represents a network request, such as an HTTP request.
.envoy.service.auth.v3.AttributeContext.Request request = 4;- Specified by:
getRequestOrBuilderin interfaceAttributeContextOrBuilder
-
getContextExtensionsCount
public int getContextExtensionsCount()
Description copied from interface:AttributeContextOrBuilderThis is analogous to http_request.headers, however these contents will not be sent to the upstream server. Context_extensions provide an extension mechanism for sending additional information to the auth server without modifying the proto definition. It maps to the internal opaque context in the filter chain.
map<string, string> context_extensions = 10;- Specified by:
getContextExtensionsCountin interfaceAttributeContextOrBuilder
-
containsContextExtensions
public boolean containsContextExtensions(String key)
This is analogous to http_request.headers, however these contents will not be sent to the upstream server. Context_extensions provide an extension mechanism for sending additional information to the auth server without modifying the proto definition. It maps to the internal opaque context in the filter chain.
map<string, string> context_extensions = 10;- Specified by:
containsContextExtensionsin interfaceAttributeContextOrBuilder
-
getContextExtensions
@Deprecated public Map<String,String> getContextExtensions()
Deprecated.UsegetContextExtensionsMap()instead.- Specified by:
getContextExtensionsin interfaceAttributeContextOrBuilder
-
getContextExtensionsMap
public Map<String,String> getContextExtensionsMap()
This is analogous to http_request.headers, however these contents will not be sent to the upstream server. Context_extensions provide an extension mechanism for sending additional information to the auth server without modifying the proto definition. It maps to the internal opaque context in the filter chain.
map<string, string> context_extensions = 10;- Specified by:
getContextExtensionsMapin interfaceAttributeContextOrBuilder
-
getContextExtensionsOrDefault
public String getContextExtensionsOrDefault(String key, String defaultValue)
This is analogous to http_request.headers, however these contents will not be sent to the upstream server. Context_extensions provide an extension mechanism for sending additional information to the auth server without modifying the proto definition. It maps to the internal opaque context in the filter chain.
map<string, string> context_extensions = 10;- Specified by:
getContextExtensionsOrDefaultin interfaceAttributeContextOrBuilder
-
getContextExtensionsOrThrow
public String getContextExtensionsOrThrow(String key)
This is analogous to http_request.headers, however these contents will not be sent to the upstream server. Context_extensions provide an extension mechanism for sending additional information to the auth server without modifying the proto definition. It maps to the internal opaque context in the filter chain.
map<string, string> context_extensions = 10;- Specified by:
getContextExtensionsOrThrowin interfaceAttributeContextOrBuilder
-
hasMetadataContext
public boolean hasMetadataContext()
Dynamic metadata associated with the request.
.envoy.config.core.v3.Metadata metadata_context = 11;- Specified by:
hasMetadataContextin interfaceAttributeContextOrBuilder- Returns:
- Whether the metadataContext field is set.
-
getMetadataContext
public Metadata getMetadataContext()
Dynamic metadata associated with the request.
.envoy.config.core.v3.Metadata metadata_context = 11;- Specified by:
getMetadataContextin interfaceAttributeContextOrBuilder- Returns:
- The metadataContext.
-
getMetadataContextOrBuilder
public MetadataOrBuilder getMetadataContextOrBuilder()
Dynamic metadata associated with the request.
.envoy.config.core.v3.Metadata metadata_context = 11;- Specified by:
getMetadataContextOrBuilderin interfaceAttributeContextOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static AttributeContext parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AttributeContext parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AttributeContext parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AttributeContext parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AttributeContext parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AttributeContext parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AttributeContext parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static AttributeContext parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static AttributeContext parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static AttributeContext parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static AttributeContext parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static AttributeContext parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public AttributeContext.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static AttributeContext.Builder newBuilder()
-
newBuilder
public static AttributeContext.Builder newBuilder(AttributeContext prototype)
-
toBuilder
public AttributeContext.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected AttributeContext.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static AttributeContext getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<AttributeContext> parser()
-
getParserForType
public com.google.protobuf.Parser<AttributeContext> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public AttributeContext getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-