Interface AwsRequestSigningOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AwsRequestSigning, AwsRequestSigning.Builder

    public interface AwsRequestSigningOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getHostRewrite()
      Indicates that before signing headers, the host header will be swapped with this value.
      com.google.protobuf.ByteString getHostRewriteBytes()
      Indicates that before signing headers, the host header will be swapped with this value.
      String getRegion()
      The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP endpoint.
      com.google.protobuf.ByteString getRegionBytes()
      The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP endpoint.
      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.
      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.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getServiceName

        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) = { ... }
        Returns:
        The serviceName.
      • getServiceNameBytes

        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) = { ... }
        Returns:
        The bytes for serviceName.
      • getRegion

        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) = { ... }
        Returns:
        The region.
      • getRegionBytes

        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) = { ... }
        Returns:
        The bytes for region.
      • getHostRewrite

        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;
        Returns:
        The hostRewrite.
      • getHostRewriteBytes

        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;
        Returns:
        The bytes for hostRewrite.