AttributeContext (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.service.auth.v4alpha.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 type envoy.service.auth.v4alpha.AttributeContext

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AttributeContext.Builder` An attribute is a piece of metadata that describes an activity on a network.
`static class`	`AttributeContext.HttpRequest` This message defines attributes for an HTTP request.
`static interface`	`AttributeContext.HttpRequestOrBuilder`
`static class`	`AttributeContext.Peer` This message defines attributes for a node that handles a network request.
`static interface`	`AttributeContext.PeerOrBuilder`
`static class`	`AttributeContext.Request` Represents a network request, such as an HTTP request.
`static interface`	`AttributeContext.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 and Description
`static int`	`CONTEXT_EXTENSIONS_FIELD_NUMBER`
`static int`	`DESTINATION_FIELD_NUMBER`
`static int`	`METADATA_CONTEXT_FIELD_NUMBER`
`static int`	`REQUEST_FIELD_NUMBER`
`static int`	`SOURCE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsContextExtensions(String key)` This is analogous to http_request.headers, however these contents will not be sent to the upstream server.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getContextExtensions()` Deprecated.
`int`	`getContextExtensionsCount()` 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.
`String`	`getContextExtensionsOrDefault(String key, String defaultValue)` This is analogous to http_request.headers, however these contents will not be sent to the upstream server.
`String`	`getContextExtensionsOrThrow(String key)` This is analogous to http_request.headers, however these contents will not be sent to the upstream server.
`static AttributeContext`	`getDefaultInstance()`
`AttributeContext`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`AttributeContext.Peer`	`getDestination()` The destination of a network activity, such as accepting a TCP connection.
`AttributeContext.PeerOrBuilder`	`getDestinationOrBuilder()` The destination of a network activity, such as accepting a TCP connection.
`Metadata`	`getMetadataContext()` Dynamic metadata associated with the request.
`MetadataOrBuilder`	`getMetadataContextOrBuilder()` Dynamic metadata associated with the request.
`com.google.protobuf.Parser<AttributeContext>`	`getParserForType()`
`AttributeContext.Request`	`getRequest()` Represents a network request, such as an HTTP request.
`AttributeContext.RequestOrBuilder`	`getRequestOrBuilder()` Represents a network request, such as an HTTP request.
`int`	`getSerializedSize()`
`AttributeContext.Peer`	`getSource()` The source of a network activity, such as starting a TCP connection.
`AttributeContext.PeerOrBuilder`	`getSourceOrBuilder()` The source of a network activity, such as starting a TCP connection.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasDestination()` The destination of a network activity, such as accepting a TCP connection.
`int`	`hashCode()`
`boolean`	`hasMetadataContext()` Dynamic metadata associated with the request.
`boolean`	`hasRequest()` Represents a network request, such as an HTTP request.
`boolean`	`hasSource()` The source of a network activity, such as starting a TCP connection.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static AttributeContext.Builder`	`newBuilder()`
`static AttributeContext.Builder`	`newBuilder(AttributeContext prototype)`
`AttributeContext.Builder`	`newBuilderForType()`
`protected AttributeContext.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static AttributeContext`	`parseDelimitedFrom(InputStream input)`
`static AttributeContext`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AttributeContext`	`parseFrom(byte[] data)`
`static AttributeContext`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AttributeContext`	`parseFrom(ByteBuffer data)`
`static AttributeContext`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AttributeContext`	`parseFrom(com.google.protobuf.ByteString data)`
`static AttributeContext`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AttributeContext`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static AttributeContext`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static AttributeContext`	`parseFrom(InputStream input)`
`static AttributeContext`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<AttributeContext>`	`parser()`
`AttributeContext.Builder`	`toBuilder()`
`void`	`writeTo(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, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

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:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.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.v4alpha.AttributeContext.Peer source = 1;

Specified by:: hasSource in interface AttributeContextOrBuilder

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.v4alpha.AttributeContext.Peer source = 1;

Specified by:: getSource in interface AttributeContextOrBuilder

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.v4alpha.AttributeContext.Peer source = 1;

Specified by:: getSourceOrBuilder in interface AttributeContextOrBuilder

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.v4alpha.AttributeContext.Peer destination = 2;

Specified by:: hasDestination in interface AttributeContextOrBuilder

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.v4alpha.AttributeContext.Peer destination = 2;

Specified by:: getDestination in interface AttributeContextOrBuilder

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.v4alpha.AttributeContext.Peer destination = 2;

Specified by:: getDestinationOrBuilder in interface AttributeContextOrBuilder

hasRequest
```
public boolean hasRequest()
```
```
 Represents a network request, such as an HTTP request.
 
```
.envoy.service.auth.v4alpha.AttributeContext.Request request = 4;
Specified by:

hasRequest in interface AttributeContextOrBuilder

getRequest
```
public AttributeContext.Request getRequest()
```
```
 Represents a network request, such as an HTTP request.
 
```
.envoy.service.auth.v4alpha.AttributeContext.Request request = 4;
Specified by:

getRequest in interface AttributeContextOrBuilder

getRequestOrBuilder
```
public AttributeContext.RequestOrBuilder getRequestOrBuilder()
```
```
 Represents a network request, such as an HTTP request.
 
```
.envoy.service.auth.v4alpha.AttributeContext.Request request = 4;
Specified by:

getRequestOrBuilder in interface AttributeContextOrBuilder