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

Class AwsRequestSigning.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>
io.envoyproxy.envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AwsRequestSigningOrBuilder, Cloneable
Enclosing class:
AwsRequestSigning
public static final class AwsRequestSigning.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder> implements AwsRequestSigningOrBuilder
 Top level configuration for the AWS request signing filter.
 [#next-free-field: 10]
Protobuf type envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning

  • Method Details

    • 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.Builder<AwsRequestSigning.Builder>

    • clear

      public AwsRequestSigning.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>

    • getDefaultInstanceForType

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

    • build

      public AwsRequestSigning build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public AwsRequestSigning buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public AwsRequestSigning.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>

    • setField

      public AwsRequestSigning.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>

    • clearField

      public AwsRequestSigning.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>

    • clearOneof

      public AwsRequestSigning.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>

    • setRepeatedField

      public AwsRequestSigning.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>

    • addRepeatedField

      public AwsRequestSigning.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>

    • mergeFrom

      public AwsRequestSigning.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AwsRequestSigning.Builder>

    • mergeFrom

      public AwsRequestSigning.Builder mergeFrom(AwsRequestSigning other)

    • isInitialized

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

    • mergeFrom

      public AwsRequestSigning.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AwsRequestSigning.Builder>
      Throws:
      IOException

    • getServiceName

      public String getServiceName()
       The `service namespace
 <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_
 of the HTTP endpoint.

 Example: s3
      string service_name = 1 [(.validate.rules) = { ... }
      Specified by:
      getServiceName in interface AwsRequestSigningOrBuilder
      Returns:
      The serviceName.

    • getServiceNameBytes

      public com.google.protobuf.ByteString getServiceNameBytes()
       The `service namespace
 <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_
 of the HTTP endpoint.

 Example: s3
      string service_name = 1 [(.validate.rules) = { ... }
      Specified by:
      getServiceNameBytes in interface AwsRequestSigningOrBuilder
      Returns:
      The bytes for serviceName.

    • setServiceName

      public AwsRequestSigning.Builder setServiceName(String value)
       The `service namespace
 <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_
 of the HTTP endpoint.

 Example: s3
      string service_name = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The serviceName to set.
      Returns:
      This builder for chaining.

    • clearServiceName

      public AwsRequestSigning.Builder clearServiceName()
       The `service namespace
 <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_
 of the HTTP endpoint.

 Example: s3
      string service_name = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setServiceNameBytes

      public AwsRequestSigning.Builder setServiceNameBytes(com.google.protobuf.ByteString value)
       The `service namespace
 <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_
 of the HTTP endpoint.

 Example: s3
      string service_name = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for serviceName to set.
      Returns:
      This builder for chaining.

    • getRegion

      public String getRegion()
       Optional region string. If region is not provided, the region will be retrieved from the environment
 or AWS configuration files. See :ref:`config_http_filters_aws_request_signing_region` for more details.

 When signing_algorithm is set to ``AWS_SIGV4`` the region is a standard AWS `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ string for the service
 hosting the HTTP endpoint.

 Example: ``us-west-2``

 When signing_algorithm is set to ``AWS_SIGV4A`` the region is used as a region set.

 A region set is a comma separated list of AWS regions, such as ``us-east-1,us-east-2`` or wildcard ``*``
 or even region strings containing wildcards such as ``us-east-*``

 Example: ``'*'``

 By configuring a region set, a SigV4A signed request can be sent to multiple regions, rather than being
 valid for only a single region destination.
      string region = 2;
      Specified by:
      getRegion in interface AwsRequestSigningOrBuilder
      Returns:
      The region.

    • getRegionBytes

      public com.google.protobuf.ByteString getRegionBytes()
       Optional region string. If region is not provided, the region will be retrieved from the environment
 or AWS configuration files. See :ref:`config_http_filters_aws_request_signing_region` for more details.

 When signing_algorithm is set to ``AWS_SIGV4`` the region is a standard AWS `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ string for the service
 hosting the HTTP endpoint.

 Example: ``us-west-2``

 When signing_algorithm is set to ``AWS_SIGV4A`` the region is used as a region set.

 A region set is a comma separated list of AWS regions, such as ``us-east-1,us-east-2`` or wildcard ``*``
 or even region strings containing wildcards such as ``us-east-*``

 Example: ``'*'``

 By configuring a region set, a SigV4A signed request can be sent to multiple regions, rather than being
 valid for only a single region destination.
      string region = 2;
      Specified by:
      getRegionBytes in interface AwsRequestSigningOrBuilder
      Returns:
      The bytes for region.

    • setRegion

      public AwsRequestSigning.Builder setRegion(String value)
       Optional region string. If region is not provided, the region will be retrieved from the environment
 or AWS configuration files. See :ref:`config_http_filters_aws_request_signing_region` for more details.

 When signing_algorithm is set to ``AWS_SIGV4`` the region is a standard AWS `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ string for the service
 hosting the HTTP endpoint.

 Example: ``us-west-2``

 When signing_algorithm is set to ``AWS_SIGV4A`` the region is used as a region set.

 A region set is a comma separated list of AWS regions, such as ``us-east-1,us-east-2`` or wildcard ``*``
 or even region strings containing wildcards such as ``us-east-*``

 Example: ``'*'``

 By configuring a region set, a SigV4A signed request can be sent to multiple regions, rather than being
 valid for only a single region destination.
      string region = 2;
      Parameters:
      value - The region to set.
      Returns:
      This builder for chaining.

    • clearRegion

      public AwsRequestSigning.Builder clearRegion()
       Optional region string. If region is not provided, the region will be retrieved from the environment
 or AWS configuration files. See :ref:`config_http_filters_aws_request_signing_region` for more details.

 When signing_algorithm is set to ``AWS_SIGV4`` the region is a standard AWS `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ string for the service
 hosting the HTTP endpoint.

 Example: ``us-west-2``

 When signing_algorithm is set to ``AWS_SIGV4A`` the region is used as a region set.

 A region set is a comma separated list of AWS regions, such as ``us-east-1,us-east-2`` or wildcard ``*``
 or even region strings containing wildcards such as ``us-east-*``

 Example: ``'*'``

 By configuring a region set, a SigV4A signed request can be sent to multiple regions, rather than being
 valid for only a single region destination.
      string region = 2;
      Returns:
      This builder for chaining.

    • setRegionBytes

      public AwsRequestSigning.Builder setRegionBytes(com.google.protobuf.ByteString value)
       Optional region string. If region is not provided, the region will be retrieved from the environment
 or AWS configuration files. See :ref:`config_http_filters_aws_request_signing_region` for more details.

 When signing_algorithm is set to ``AWS_SIGV4`` the region is a standard AWS `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ string for the service
 hosting the HTTP endpoint.

 Example: ``us-west-2``

 When signing_algorithm is set to ``AWS_SIGV4A`` the region is used as a region set.

 A region set is a comma separated list of AWS regions, such as ``us-east-1,us-east-2`` or wildcard ``*``
 or even region strings containing wildcards such as ``us-east-*``

 Example: ``'*'``

 By configuring a region set, a SigV4A signed request can be sent to multiple regions, rather than being
 valid for only a single region destination.
      string region = 2;
      Parameters:
      value - The bytes for region to set.
      Returns:
      This builder for chaining.

    • getHostRewrite

      public String getHostRewrite()
       Indicates that before signing headers, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::
     This rewrite affects both signing and host header forwarding. However, this
     option shouldn't be used with
     :ref:`HCM host rewrite <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` given that the
     value set here would be used for signing whereas the value set in the HCM would be used
     for host header forwarding which is not the desired outcome.
      string host_rewrite = 3;
      Specified by:
      getHostRewrite in interface AwsRequestSigningOrBuilder
      Returns:
      The hostRewrite.

    • getHostRewriteBytes

      public com.google.protobuf.ByteString getHostRewriteBytes()
       Indicates that before signing headers, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::
     This rewrite affects both signing and host header forwarding. However, this
     option shouldn't be used with
     :ref:`HCM host rewrite <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` given that the
     value set here would be used for signing whereas the value set in the HCM would be used
     for host header forwarding which is not the desired outcome.
      string host_rewrite = 3;
      Specified by:
      getHostRewriteBytes in interface AwsRequestSigningOrBuilder
      Returns:
      The bytes for hostRewrite.

    • setHostRewrite

      public AwsRequestSigning.Builder setHostRewrite(String value)
       Indicates that before signing headers, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::
     This rewrite affects both signing and host header forwarding. However, this
     option shouldn't be used with
     :ref:`HCM host rewrite <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` given that the
     value set here would be used for signing whereas the value set in the HCM would be used
     for host header forwarding which is not the desired outcome.
      string host_rewrite = 3;
      Parameters:
      value - The hostRewrite to set.
      Returns:
      This builder for chaining.

    • clearHostRewrite

      public AwsRequestSigning.Builder clearHostRewrite()
       Indicates that before signing headers, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::
     This rewrite affects both signing and host header forwarding. However, this
     option shouldn't be used with
     :ref:`HCM host rewrite <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` given that the
     value set here would be used for signing whereas the value set in the HCM would be used
     for host header forwarding which is not the desired outcome.
      string host_rewrite = 3;
      Returns:
      This builder for chaining.

    • setHostRewriteBytes

      public AwsRequestSigning.Builder setHostRewriteBytes(com.google.protobuf.ByteString value)
       Indicates that before signing headers, the host header will be swapped with
 this value. If not set or empty, the original host header value
 will be used and no rewrite will happen.

 .. note::
     This rewrite affects both signing and host header forwarding. However, this
     option shouldn't be used with
     :ref:`HCM host rewrite <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` given that the
     value set here would be used for signing whereas the value set in the HCM would be used
     for host header forwarding which is not the desired outcome.
      string host_rewrite = 3;
      Parameters:
      value - The bytes for hostRewrite to set.
      Returns:
      This builder for chaining.

    • getUseUnsignedPayload

      public boolean getUseUnsignedPayload()
       Instead of buffering the request to calculate the payload hash, use the literal string ``UNSIGNED-PAYLOAD``
 to calculate the payload hash. Not all services support this option. See the `S3
 <https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html>`_ policy for details.
      bool use_unsigned_payload = 4;
      Specified by:
      getUseUnsignedPayload in interface AwsRequestSigningOrBuilder
      Returns:
      The useUnsignedPayload.

    • setUseUnsignedPayload

      public AwsRequestSigning.Builder setUseUnsignedPayload(boolean value)
       Instead of buffering the request to calculate the payload hash, use the literal string ``UNSIGNED-PAYLOAD``
 to calculate the payload hash. Not all services support this option. See the `S3
 <https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html>`_ policy for details.
      bool use_unsigned_payload = 4;
      Parameters:
      value - The useUnsignedPayload to set.
      Returns:
      This builder for chaining.

    • clearUseUnsignedPayload

      public AwsRequestSigning.Builder clearUseUnsignedPayload()
       Instead of buffering the request to calculate the payload hash, use the literal string ``UNSIGNED-PAYLOAD``
 to calculate the payload hash. Not all services support this option. See the `S3
 <https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html>`_ policy for details.
      bool use_unsigned_payload = 4;
      Returns:
      This builder for chaining.

    • getMatchExcludedHeadersList

      public List<StringMatcher> getMatchExcludedHeadersList()
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;
      Specified by:
      getMatchExcludedHeadersList in interface AwsRequestSigningOrBuilder

    • getMatchExcludedHeadersCount

      public int getMatchExcludedHeadersCount()
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;
      Specified by:
      getMatchExcludedHeadersCount in interface AwsRequestSigningOrBuilder

    • getMatchExcludedHeaders

      public StringMatcher getMatchExcludedHeaders(int index)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;
      Specified by:
      getMatchExcludedHeaders in interface AwsRequestSigningOrBuilder

    • setMatchExcludedHeaders

      public AwsRequestSigning.Builder setMatchExcludedHeaders(int index, StringMatcher value)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • setMatchExcludedHeaders

      public AwsRequestSigning.Builder setMatchExcludedHeaders(int index, StringMatcher.Builder builderForValue)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • addMatchExcludedHeaders

      public AwsRequestSigning.Builder addMatchExcludedHeaders(StringMatcher value)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • addMatchExcludedHeaders

      public AwsRequestSigning.Builder addMatchExcludedHeaders(int index, StringMatcher value)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • addMatchExcludedHeaders

      public AwsRequestSigning.Builder addMatchExcludedHeaders(StringMatcher.Builder builderForValue)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • addMatchExcludedHeaders

      public AwsRequestSigning.Builder addMatchExcludedHeaders(int index, StringMatcher.Builder builderForValue)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • addAllMatchExcludedHeaders

      public AwsRequestSigning.Builder addAllMatchExcludedHeaders(Iterable<? extends StringMatcher> values)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • clearMatchExcludedHeaders

      public AwsRequestSigning.Builder clearMatchExcludedHeaders()
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • removeMatchExcludedHeaders

      public AwsRequestSigning.Builder removeMatchExcludedHeaders(int index)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • getMatchExcludedHeadersBuilder

      public StringMatcher.Builder getMatchExcludedHeadersBuilder(int index)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • getMatchExcludedHeadersOrBuilder

      public StringMatcherOrBuilder getMatchExcludedHeadersOrBuilder(int index)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;
      Specified by:
      getMatchExcludedHeadersOrBuilder in interface AwsRequestSigningOrBuilder

    • getMatchExcludedHeadersOrBuilderList

      public List<? extends StringMatcherOrBuilder> getMatchExcludedHeadersOrBuilderList()
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;
      Specified by:
      getMatchExcludedHeadersOrBuilderList in interface AwsRequestSigningOrBuilder

    • addMatchExcludedHeadersBuilder

      public StringMatcher.Builder addMatchExcludedHeadersBuilder()
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • addMatchExcludedHeadersBuilder

      public StringMatcher.Builder addMatchExcludedHeadersBuilder(int index)
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • getMatchExcludedHeadersBuilderList

      public List<StringMatcher.Builder> getMatchExcludedHeadersBuilderList()
       A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).

 Example:

 .. code-block:: yaml

  match_excluded_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will not be signed.
      repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

    • getSigningAlgorithmValue

      public int getSigningAlgorithmValue()
       Optional Signing algorithm specifier, either ``AWS_SIGV4`` or ``AWS_SIGV4A``, defaulting to ``AWS_SIGV4``.
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.SigningAlgorithm signing_algorithm = 6;
      Specified by:
      getSigningAlgorithmValue in interface AwsRequestSigningOrBuilder
      Returns:
      The enum numeric value on the wire for signingAlgorithm.

    • setSigningAlgorithmValue

      public AwsRequestSigning.Builder setSigningAlgorithmValue(int value)
       Optional Signing algorithm specifier, either ``AWS_SIGV4`` or ``AWS_SIGV4A``, defaulting to ``AWS_SIGV4``.
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.SigningAlgorithm signing_algorithm = 6;
      Parameters:
      value - The enum numeric value on the wire for signingAlgorithm to set.
      Returns:
      This builder for chaining.

    • getSigningAlgorithm

      public AwsRequestSigning.SigningAlgorithm getSigningAlgorithm()
       Optional Signing algorithm specifier, either ``AWS_SIGV4`` or ``AWS_SIGV4A``, defaulting to ``AWS_SIGV4``.
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.SigningAlgorithm signing_algorithm = 6;
      Specified by:
      getSigningAlgorithm in interface AwsRequestSigningOrBuilder
      Returns:
      The signingAlgorithm.

    • setSigningAlgorithm

      public AwsRequestSigning.Builder setSigningAlgorithm(AwsRequestSigning.SigningAlgorithm value)
       Optional Signing algorithm specifier, either ``AWS_SIGV4`` or ``AWS_SIGV4A``, defaulting to ``AWS_SIGV4``.
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.SigningAlgorithm signing_algorithm = 6;
      Parameters:
      value - The signingAlgorithm to set.
      Returns:
      This builder for chaining.

    • clearSigningAlgorithm

      public AwsRequestSigning.Builder clearSigningAlgorithm()
       Optional Signing algorithm specifier, either ``AWS_SIGV4`` or ``AWS_SIGV4A``, defaulting to ``AWS_SIGV4``.
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.SigningAlgorithm signing_algorithm = 6;
      Returns:
      This builder for chaining.

    • hasQueryString

      public boolean hasQueryString()
       If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string``
 is configured.

 Example:
 query_string: {}
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;
      Specified by:
      hasQueryString in interface AwsRequestSigningOrBuilder
      Returns:
      Whether the queryString field is set.

    • getQueryString

      public AwsRequestSigning.QueryString getQueryString()
       If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string``
 is configured.

 Example:
 query_string: {}
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;
      Specified by:
      getQueryString in interface AwsRequestSigningOrBuilder
      Returns:
      The queryString.

    • setQueryString

      public AwsRequestSigning.Builder setQueryString(AwsRequestSigning.QueryString value)
       If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string``
 is configured.

 Example:
 query_string: {}
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;

    • setQueryString

      public AwsRequestSigning.Builder setQueryString(AwsRequestSigning.QueryString.Builder builderForValue)
       If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string``
 is configured.

 Example:
 query_string: {}
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;

    • mergeQueryString

      public AwsRequestSigning.Builder mergeQueryString(AwsRequestSigning.QueryString value)
       If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string``
 is configured.

 Example:
 query_string: {}
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;

    • clearQueryString

      public AwsRequestSigning.Builder clearQueryString()
       If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string``
 is configured.

 Example:
 query_string: {}
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;

    • getQueryStringBuilder

      public AwsRequestSigning.QueryString.Builder getQueryStringBuilder()
       If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string``
 is configured.

 Example:
 query_string: {}
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;

    • getQueryStringOrBuilder

      public AwsRequestSigning.QueryStringOrBuilder getQueryStringOrBuilder()
       If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string``
 is configured.

 Example:
 query_string: {}
      .envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;
      Specified by:
      getQueryStringOrBuilder in interface AwsRequestSigningOrBuilder

    • hasCredentialProvider

      public boolean hasCredentialProvider()
       The credential provider for signing the request. This is optional and if not set,
 it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;
      Specified by:
      hasCredentialProvider in interface AwsRequestSigningOrBuilder
      Returns:
      Whether the credentialProvider field is set.

    • getCredentialProvider

      public AwsCredentialProvider getCredentialProvider()
       The credential provider for signing the request. This is optional and if not set,
 it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;
      Specified by:
      getCredentialProvider in interface AwsRequestSigningOrBuilder
      Returns:
      The credentialProvider.

    • setCredentialProvider

      public AwsRequestSigning.Builder setCredentialProvider(AwsCredentialProvider value)
       The credential provider for signing the request. This is optional and if not set,
 it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;

    • setCredentialProvider

      public AwsRequestSigning.Builder setCredentialProvider(AwsCredentialProvider.Builder builderForValue)
       The credential provider for signing the request. This is optional and if not set,
 it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;

    • mergeCredentialProvider

      public AwsRequestSigning.Builder mergeCredentialProvider(AwsCredentialProvider value)
       The credential provider for signing the request. This is optional and if not set,
 it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;

    • clearCredentialProvider

      public AwsRequestSigning.Builder clearCredentialProvider()
       The credential provider for signing the request. This is optional and if not set,
 it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;

    • getCredentialProviderBuilder

      public AwsCredentialProvider.Builder getCredentialProviderBuilder()
       The credential provider for signing the request. This is optional and if not set,
 it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;

    • getCredentialProviderOrBuilder

      public AwsCredentialProviderOrBuilder getCredentialProviderOrBuilder()
       The credential provider for signing the request. This is optional and if not set,
 it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
      .envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;
      Specified by:
      getCredentialProviderOrBuilder in interface AwsRequestSigningOrBuilder

    • getMatchIncludedHeadersList

      public List<StringMatcher> getMatchIncludedHeadersList()
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;
      Specified by:
      getMatchIncludedHeadersList in interface AwsRequestSigningOrBuilder

    • getMatchIncludedHeadersCount

      public int getMatchIncludedHeadersCount()
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;
      Specified by:
      getMatchIncludedHeadersCount in interface AwsRequestSigningOrBuilder

    • getMatchIncludedHeaders

      public StringMatcher getMatchIncludedHeaders(int index)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;
      Specified by:
      getMatchIncludedHeaders in interface AwsRequestSigningOrBuilder

    • setMatchIncludedHeaders

      public AwsRequestSigning.Builder setMatchIncludedHeaders(int index, StringMatcher value)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • setMatchIncludedHeaders

      public AwsRequestSigning.Builder setMatchIncludedHeaders(int index, StringMatcher.Builder builderForValue)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • addMatchIncludedHeaders

      public AwsRequestSigning.Builder addMatchIncludedHeaders(StringMatcher value)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • addMatchIncludedHeaders

      public AwsRequestSigning.Builder addMatchIncludedHeaders(int index, StringMatcher value)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • addMatchIncludedHeaders

      public AwsRequestSigning.Builder addMatchIncludedHeaders(StringMatcher.Builder builderForValue)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • addMatchIncludedHeaders

      public AwsRequestSigning.Builder addMatchIncludedHeaders(int index, StringMatcher.Builder builderForValue)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • addAllMatchIncludedHeaders

      public AwsRequestSigning.Builder addAllMatchIncludedHeaders(Iterable<? extends StringMatcher> values)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • clearMatchIncludedHeaders

      public AwsRequestSigning.Builder clearMatchIncludedHeaders()
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • removeMatchIncludedHeaders

      public AwsRequestSigning.Builder removeMatchIncludedHeaders(int index)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • getMatchIncludedHeadersBuilder

      public StringMatcher.Builder getMatchIncludedHeadersBuilder(int index)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • getMatchIncludedHeadersOrBuilder

      public StringMatcherOrBuilder getMatchIncludedHeadersOrBuilder(int index)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;
      Specified by:
      getMatchIncludedHeadersOrBuilder in interface AwsRequestSigningOrBuilder

    • getMatchIncludedHeadersOrBuilderList

      public List<? extends StringMatcherOrBuilder> getMatchIncludedHeadersOrBuilderList()
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;
      Specified by:
      getMatchIncludedHeadersOrBuilderList in interface AwsRequestSigningOrBuilder

    • addMatchIncludedHeadersBuilder

      public StringMatcher.Builder addMatchIncludedHeadersBuilder()
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • addMatchIncludedHeadersBuilder

      public StringMatcher.Builder addMatchIncludedHeadersBuilder(int index)
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • getMatchIncludedHeadersBuilderList

      public List<StringMatcher.Builder> getMatchIncludedHeadersBuilderList()
       A list of request header string matchers that will be included during signing. The included header can be matched by
 any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
 match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored.
 Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_.

 Example:

 .. code-block:: yaml

  match_included_headers:
  - prefix: x-envoy
  - exact: foo
  - exact: bar

 When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
      repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;

    • setUnknownFields

      public final AwsRequestSigning.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>

    • mergeUnknownFields

      public final AwsRequestSigning.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AwsRequestSigning.Builder>