Package io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3

Class MetadataOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.ext_proc.v3.MetadataOptions
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetadataOptionsOrBuilder, Serializable
public final class MetadataOptions extends com.google.protobuf.GeneratedMessageV3 implements MetadataOptionsOrBuilder
 The MetadataOptions structure defines options for the sending and receiving of
 dynamic metadata. Specifically, which namespaces to send to the server, whether
 metadata returned by the server may be written, and how that metadata may be written.
Protobuf type envoy.extensions.filters.http.ext_proc.v3.MetadataOptions
See Also:

  • Field Details

    • FORWARDING_NAMESPACES_FIELD_NUMBER

      public static final int FORWARDING_NAMESPACES_FIELD_NUMBER
      See Also:

    • RECEIVING_NAMESPACES_FIELD_NUMBER

      public static final int RECEIVING_NAMESPACES_FIELD_NUMBER
      See Also:

    • CLUSTER_METADATA_FORWARDING_NAMESPACES_FIELD_NUMBER

      public static final int CLUSTER_METADATA_FORWARDING_NAMESPACES_FIELD_NUMBER
      See Also:

  • 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()

    • internalGetFieldAccessorTable

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

    • hasForwardingNamespaces

      public boolean hasForwardingNamespaces()
       Describes which typed or untyped filter dynamic metadata namespaces to forward to
 the external processing server.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions.MetadataNamespaces forwarding_namespaces = 1;
      Specified by:
      hasForwardingNamespaces in interface MetadataOptionsOrBuilder
      Returns:
      Whether the forwardingNamespaces field is set.

    • getForwardingNamespaces

      public MetadataOptions.MetadataNamespaces getForwardingNamespaces()
       Describes which typed or untyped filter dynamic metadata namespaces to forward to
 the external processing server.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions.MetadataNamespaces forwarding_namespaces = 1;
      Specified by:
      getForwardingNamespaces in interface MetadataOptionsOrBuilder
      Returns:
      The forwardingNamespaces.

    • getForwardingNamespacesOrBuilder

      public MetadataOptions.MetadataNamespacesOrBuilder getForwardingNamespacesOrBuilder()
       Describes which typed or untyped filter dynamic metadata namespaces to forward to
 the external processing server.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions.MetadataNamespaces forwarding_namespaces = 1;
      Specified by:
      getForwardingNamespacesOrBuilder in interface MetadataOptionsOrBuilder

    • hasReceivingNamespaces

      public boolean hasReceivingNamespaces()
       Describes which typed or untyped filter dynamic metadata namespaces to accept from
 the external processing server. Set to empty or leave unset to disallow writing
 any received dynamic metadata. Receiving of typed metadata is not supported.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions.MetadataNamespaces receiving_namespaces = 2;
      Specified by:
      hasReceivingNamespaces in interface MetadataOptionsOrBuilder
      Returns:
      Whether the receivingNamespaces field is set.

    • getReceivingNamespaces

      public MetadataOptions.MetadataNamespaces getReceivingNamespaces()
       Describes which typed or untyped filter dynamic metadata namespaces to accept from
 the external processing server. Set to empty or leave unset to disallow writing
 any received dynamic metadata. Receiving of typed metadata is not supported.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions.MetadataNamespaces receiving_namespaces = 2;
      Specified by:
      getReceivingNamespaces in interface MetadataOptionsOrBuilder
      Returns:
      The receivingNamespaces.

    • getReceivingNamespacesOrBuilder

      public MetadataOptions.MetadataNamespacesOrBuilder getReceivingNamespacesOrBuilder()
       Describes which typed or untyped filter dynamic metadata namespaces to accept from
 the external processing server. Set to empty or leave unset to disallow writing
 any received dynamic metadata. Receiving of typed metadata is not supported.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions.MetadataNamespaces receiving_namespaces = 2;
      Specified by:
      getReceivingNamespacesOrBuilder in interface MetadataOptionsOrBuilder

    • hasClusterMetadataForwardingNamespaces

      public boolean hasClusterMetadataForwardingNamespaces()
       Describes which cluster metadata namespaces to forward to
 the external processing server.
 .. note::
 This is the least specific metadata. Should there be any namespace collision,
 cluster level metadata can be overridden by filter metadata.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions.MetadataNamespaces cluster_metadata_forwarding_namespaces = 3;
      Specified by:
      hasClusterMetadataForwardingNamespaces in interface MetadataOptionsOrBuilder
      Returns:
      Whether the clusterMetadataForwardingNamespaces field is set.

    • getClusterMetadataForwardingNamespaces

      public MetadataOptions.MetadataNamespaces getClusterMetadataForwardingNamespaces()
       Describes which cluster metadata namespaces to forward to
 the external processing server.
 .. note::
 This is the least specific metadata. Should there be any namespace collision,
 cluster level metadata can be overridden by filter metadata.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions.MetadataNamespaces cluster_metadata_forwarding_namespaces = 3;
      Specified by:
      getClusterMetadataForwardingNamespaces in interface MetadataOptionsOrBuilder
      Returns:
      The clusterMetadataForwardingNamespaces.

    • getClusterMetadataForwardingNamespacesOrBuilder

      public MetadataOptions.MetadataNamespacesOrBuilder getClusterMetadataForwardingNamespacesOrBuilder()
       Describes which cluster metadata namespaces to forward to
 the external processing server.
 .. note::
 This is the least specific metadata. Should there be any namespace collision,
 cluster level metadata can be overridden by filter metadata.
      .envoy.extensions.filters.http.ext_proc.v3.MetadataOptions.MetadataNamespaces cluster_metadata_forwarding_namespaces = 3;
      Specified by:
      getClusterMetadataForwardingNamespacesOrBuilder in interface MetadataOptionsOrBuilder

    • 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 MetadataOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static MetadataOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static MetadataOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static MetadataOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static MetadataOptions.Builder newBuilder()

    • newBuilder

      public static MetadataOptions.Builder newBuilder(MetadataOptions prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static MetadataOptions getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<MetadataOptions> 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 MetadataOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder