Package io.envoyproxy.envoy.config.filter.http.aws_request_signing.v2alpha

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.config.filter.http.aws_request_signing.v2alpha.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.
Protobuf type envoy.config.filter.http.aws_request_signing.v2alpha.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()
       The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP
 endpoint.

 Example: us-west-2
      string region = 2 [(.validate.rules) = { ... }
      Specified by:
      getRegion in interface AwsRequestSigningOrBuilder
      Returns:
      The region.

    • getRegionBytes

      public com.google.protobuf.ByteString getRegionBytes()
       The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP
 endpoint.

 Example: us-west-2
      string region = 2 [(.validate.rules) = { ... }
      Specified by:
      getRegionBytes in interface AwsRequestSigningOrBuilder
      Returns:
      The bytes for region.

    • setRegion

      public AwsRequestSigning.Builder setRegion(String value)
       The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP
 endpoint.

 Example: us-west-2
      string region = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The region to set.
      Returns:
      This builder for chaining.

    • clearRegion

      public AwsRequestSigning.Builder clearRegion()
       The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP
 endpoint.

 Example: us-west-2
      string region = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setRegionBytes

      public AwsRequestSigning.Builder setRegionBytes(com.google.protobuf.ByteString value)
       The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP
 endpoint.

 Example: us-west-2
      string region = 2 [(.validate.rules) = { ... }
      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_api_field_route.RouteAction.host_rewrite>` 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_api_field_route.RouteAction.host_rewrite>` 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_api_field_route.RouteAction.host_rewrite>` 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_api_field_route.RouteAction.host_rewrite>` 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_api_field_route.RouteAction.host_rewrite>` 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.

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