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

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 Summary

Modifier and Type	Method and Description
AwsRequestSigning.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AwsRequestSigning	build()
AwsRequestSigning	buildPartial()
AwsRequestSigning.Builder	clear()
AwsRequestSigning.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AwsRequestSigning.Builder	clearHostRewrite() Indicates that before signing headers, the host header will be swapped with this value.
AwsRequestSigning.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AwsRequestSigning.Builder	clearRegion() The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP endpoint.
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.
AwsRequestSigning.Builder	clone()
AwsRequestSigning	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
AwsRequestSigning.Builder	mergeFrom(AwsRequestSigning other)
AwsRequestSigning.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AwsRequestSigning.Builder	mergeFrom(com.google.protobuf.Message other)
AwsRequestSigning.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AwsRequestSigning.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AwsRequestSigning.Builder	setHostRewrite(String value) Indicates that before signing headers, the host header will be swapped with this value.
AwsRequestSigning.Builder	setHostRewriteBytes(com.google.protobuf.ByteString value) Indicates that before signing headers, the host header will be swapped with this value.
AwsRequestSigning.Builder	setRegion(String value) The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP endpoint.
AwsRequestSigning.Builder	setRegionBytes(com.google.protobuf.ByteString value) The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP endpoint.
AwsRequestSigning.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
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.
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.
AwsRequestSigning.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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

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

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) = { ... }

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) = { ... }

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) = { ... }

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

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

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) = { ... }

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) = { ... }

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) = { ... }

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

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

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;

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;

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;

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>