Package io.envoyproxy.envoy.service.auth.v3

Class AttributeContext.Peer

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.service.auth.v3.AttributeContext.Peer
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AttributeContext.PeerOrBuilder, Serializable
Enclosing class:
AttributeContext
public static final class AttributeContext.Peer extends com.google.protobuf.GeneratedMessageV3 implements AttributeContext.PeerOrBuilder
 This message defines attributes for a node that handles a network request.
 The node can be either a service or an application that sends, forwards,
 or receives the request. Service peers should fill in the ``service``,
 ``principal``, and ``labels`` as appropriate.
 [#next-free-field: 6]
Protobuf type envoy.service.auth.v3.AttributeContext.Peer
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

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

    • hasAddress

      public boolean hasAddress()
       The address of the peer, this is typically the IP address.
 It can also be UDS path, or others.
      .envoy.config.core.v3.Address address = 1;
      Specified by:
      hasAddress in interface AttributeContext.PeerOrBuilder
      Returns:
      Whether the address field is set.

    • getAddress

      public Address getAddress()
       The address of the peer, this is typically the IP address.
 It can also be UDS path, or others.
      .envoy.config.core.v3.Address address = 1;
      Specified by:
      getAddress in interface AttributeContext.PeerOrBuilder
      Returns:
      The address.

    • getAddressOrBuilder

      public AddressOrBuilder getAddressOrBuilder()
       The address of the peer, this is typically the IP address.
 It can also be UDS path, or others.
      .envoy.config.core.v3.Address address = 1;
      Specified by:
      getAddressOrBuilder in interface AttributeContext.PeerOrBuilder

    • getService

      public String getService()
       The canonical service name of the peer.
 It should be set to :ref:`the HTTP x-envoy-downstream-service-cluster
 <config_http_conn_man_headers_downstream-service-cluster>`
 If a more trusted source of the service name is available through mTLS/secure naming, it
 should be used.
      string service = 2;
      Specified by:
      getService in interface AttributeContext.PeerOrBuilder
      Returns:
      The service.

    • getServiceBytes

      public com.google.protobuf.ByteString getServiceBytes()
       The canonical service name of the peer.
 It should be set to :ref:`the HTTP x-envoy-downstream-service-cluster
 <config_http_conn_man_headers_downstream-service-cluster>`
 If a more trusted source of the service name is available through mTLS/secure naming, it
 should be used.
      string service = 2;
      Specified by:
      getServiceBytes in interface AttributeContext.PeerOrBuilder
      Returns:
      The bytes for service.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: AttributeContext.PeerOrBuilder
       The labels associated with the peer.
 These could be pod labels for Kubernetes or tags for VMs.
 The source of the labels could be an X.509 certificate or other configuration.
      map<string, string> labels = 3;
      Specified by:
      getLabelsCount in interface AttributeContext.PeerOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       The labels associated with the peer.
 These could be pod labels for Kubernetes or tags for VMs.
 The source of the labels could be an X.509 certificate or other configuration.
      map<string, string> labels = 3;
      Specified by:
      containsLabels in interface AttributeContext.PeerOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface AttributeContext.PeerOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       The labels associated with the peer.
 These could be pod labels for Kubernetes or tags for VMs.
 The source of the labels could be an X.509 certificate or other configuration.
      map<string, string> labels = 3;
      Specified by:
      getLabelsMap in interface AttributeContext.PeerOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       The labels associated with the peer.
 These could be pod labels for Kubernetes or tags for VMs.
 The source of the labels could be an X.509 certificate or other configuration.
      map<string, string> labels = 3;
      Specified by:
      getLabelsOrDefault in interface AttributeContext.PeerOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       The labels associated with the peer.
 These could be pod labels for Kubernetes or tags for VMs.
 The source of the labels could be an X.509 certificate or other configuration.
      map<string, string> labels = 3;
      Specified by:
      getLabelsOrThrow in interface AttributeContext.PeerOrBuilder

    • getPrincipal

      public String getPrincipal()
       The authenticated identity of this peer.
 For example, the identity associated with the workload such as a service account.
 If an X.509 certificate is used to assert the identity this field should be sourced from
 ``URI Subject Alternative Names``, ``DNS Subject Alternate Names`` or ``Subject`` in that order.
 The primary identity should be the principal. The principal format is issuer specific.

 Examples:

 - SPIFFE format is ``spiffe://trust-domain/path``.
 - Google account format is ``https://accounts.google.com/{userid}``.
      string principal = 4;
      Specified by:
      getPrincipal in interface AttributeContext.PeerOrBuilder
      Returns:
      The principal.

    • getPrincipalBytes

      public com.google.protobuf.ByteString getPrincipalBytes()
       The authenticated identity of this peer.
 For example, the identity associated with the workload such as a service account.
 If an X.509 certificate is used to assert the identity this field should be sourced from
 ``URI Subject Alternative Names``, ``DNS Subject Alternate Names`` or ``Subject`` in that order.
 The primary identity should be the principal. The principal format is issuer specific.

 Examples:

 - SPIFFE format is ``spiffe://trust-domain/path``.
 - Google account format is ``https://accounts.google.com/{userid}``.
      string principal = 4;
      Specified by:
      getPrincipalBytes in interface AttributeContext.PeerOrBuilder
      Returns:
      The bytes for principal.

    • getCertificate

      public String getCertificate()
       The X.509 certificate used to authenticate the identify of this peer.
 When present, the certificate contents are encoded in URL and PEM format.
      string certificate = 5;
      Specified by:
      getCertificate in interface AttributeContext.PeerOrBuilder
      Returns:
      The certificate.

    • getCertificateBytes

      public com.google.protobuf.ByteString getCertificateBytes()
       The X.509 certificate used to authenticate the identify of this peer.
 When present, the certificate contents are encoded in URL and PEM format.
      string certificate = 5;
      Specified by:
      getCertificateBytes in interface AttributeContext.PeerOrBuilder
      Returns:
      The bytes for certificate.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static AttributeContext.Peer parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext.Peer parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext.Peer parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext.Peer 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.Peer parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext.Peer parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext.Peer parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AttributeContext.Peer parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AttributeContext.Peer parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AttributeContext.Peer parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AttributeContext.Peer parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AttributeContext.Peer parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public AttributeContext.Peer.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AttributeContext.Peer.Builder newBuilder()

    • newBuilder

      public static AttributeContext.Peer.Builder newBuilder(AttributeContext.Peer prototype)

    • toBuilder

      public AttributeContext.Peer.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AttributeContext.Peer.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static AttributeContext.Peer getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AttributeContext.Peer> parser()

    • getParserForType

      public com.google.protobuf.Parser<AttributeContext.Peer> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public AttributeContext.Peer getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder