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

Class Config

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.aws_lambda.v3.Config
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ConfigOrBuilder, Serializable
public final class Config extends com.google.protobuf.GeneratedMessageV3 implements ConfigOrBuilder
 AWS Lambda filter config
 [#next-free-field: 7]
Protobuf type envoy.extensions.filters.http.aws_lambda.v3.Config
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Config.Builder
    AWS Lambda filter config [#next-free-field: 7]
    static enum 
    Config.InvocationMode
    Protobuf enum envoy.extensions.filters.http.aws_lambda.v3.Config.InvocationMode

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ARN_FIELD_NUMBER
     
    static final int
    CREDENTIALS_FIELD_NUMBER
     
    static final int
    CREDENTIALS_PROFILE_FIELD_NUMBER
     
    static final int
    HOST_REWRITE_FIELD_NUMBER
     
    static final int
    INVOCATION_MODE_FIELD_NUMBER
     
    static final int
    PAYLOAD_PASSTHROUGH_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getArn()
    The ARN of the AWS Lambda to invoke when the filter is engaged Must be in the following format: arn:<partition>:lambda:<region>:<account-number>:function:<function-name>
    com.google.protobuf.ByteString
    getArnBytes()
    The ARN of the AWS Lambda to invoke when the filter is engaged Must be in the following format: arn:<partition>:lambda:<region>:<account-number>:function:<function-name>
    Credentials
    getCredentials()
    Specifies the credentials to be used.
    CredentialsOrBuilder
    getCredentialsOrBuilder()
    Specifies the credentials to be used.
    String
    getCredentialsProfile()
    Specifies the credentials profile to be used from the AWS credentials file.
    com.google.protobuf.ByteString
    getCredentialsProfileBytes()
    Specifies the credentials profile to be used from the AWS credentials file.
    static Config
    getDefaultInstance()
     
    Config
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    Config.InvocationMode
    getInvocationMode()
    Determines the way to invoke the Lambda function.
    int
    getInvocationModeValue()
    Determines the way to invoke the Lambda function.
    com.google.protobuf.Parser<Config>
    getParserForType()
     
    boolean
    getPayloadPassthrough()
    Whether to transform the request (headers and body) to a JSON payload or pass it as is.
    int
    getSerializedSize()
     
    boolean
    hasCredentials()
    Specifies the credentials to be used.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Config.Builder
    newBuilder()
     
    static Config.Builder
    newBuilder(Config prototype)
     
    Config.Builder
    newBuilderForType()
     
    protected Config.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Config
    parseDelimitedFrom(InputStream input)
     
    static Config
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Config
    parseFrom(byte[] data)
     
    static Config
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Config
    parseFrom(com.google.protobuf.ByteString data)
     
    static Config
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Config
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Config
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Config
    parseFrom(InputStream input)
     
    static Config
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Config
    parseFrom(ByteBuffer data)
     
    static Config
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Config>
    parser()
     
    Config.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • ARN_FIELD_NUMBER

      public static final int ARN_FIELD_NUMBER
      See Also:

    • PAYLOAD_PASSTHROUGH_FIELD_NUMBER

      public static final int PAYLOAD_PASSTHROUGH_FIELD_NUMBER
      See Also:

    • INVOCATION_MODE_FIELD_NUMBER

      public static final int INVOCATION_MODE_FIELD_NUMBER
      See Also:

    • HOST_REWRITE_FIELD_NUMBER

      public static final int HOST_REWRITE_FIELD_NUMBER
      See Also:

    • CREDENTIALS_PROFILE_FIELD_NUMBER

      public static final int CREDENTIALS_PROFILE_FIELD_NUMBER
      See Also:

    • CREDENTIALS_FIELD_NUMBER

      public static final int CREDENTIALS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

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

    • getArn

      public String getArn()
       The ARN of the AWS Lambda to invoke when the filter is engaged
 Must be in the following format:
 arn:<partition>:lambda:<region>:<account-number>:function:<function-name>
      string arn = 1 [(.validate.rules) = { ... }
      Specified by:
      getArn in interface ConfigOrBuilder
      Returns:
      The arn.

    • getArnBytes

      public com.google.protobuf.ByteString getArnBytes()
       The ARN of the AWS Lambda to invoke when the filter is engaged
 Must be in the following format:
 arn:<partition>:lambda:<region>:<account-number>:function:<function-name>
      string arn = 1 [(.validate.rules) = { ... }
      Specified by:
      getArnBytes in interface ConfigOrBuilder
      Returns:
      The bytes for arn.

    • getPayloadPassthrough

      public boolean getPayloadPassthrough()
       Whether to transform the request (headers and body) to a JSON payload or pass it as is.
      bool payload_passthrough = 2;
      Specified by:
      getPayloadPassthrough in interface ConfigOrBuilder
      Returns:
      The payloadPassthrough.

    • getInvocationModeValue

      public int getInvocationModeValue()
       Determines the way to invoke the Lambda function.
      .envoy.extensions.filters.http.aws_lambda.v3.Config.InvocationMode invocation_mode = 3 [(.validate.rules) = { ... }
      Specified by:
      getInvocationModeValue in interface ConfigOrBuilder
      Returns:
      The enum numeric value on the wire for invocationMode.

    • getInvocationMode

      public Config.InvocationMode getInvocationMode()
       Determines the way to invoke the Lambda function.
      .envoy.extensions.filters.http.aws_lambda.v3.Config.InvocationMode invocation_mode = 3 [(.validate.rules) = { ... }
      Specified by:
      getInvocationMode in interface ConfigOrBuilder
      Returns:
      The invocationMode.

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

     Changing the value of the host header can result in a different route to be selected
     if an HTTP filter after AWS lambda re-evaluates the route (clears route cache).
      string host_rewrite = 4;
      Specified by:
      getHostRewrite in interface ConfigOrBuilder
      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.

     Changing the value of the host header can result in a different route to be selected
     if an HTTP filter after AWS lambda re-evaluates the route (clears route cache).
      string host_rewrite = 4;
      Specified by:
      getHostRewriteBytes in interface ConfigOrBuilder
      Returns:
      The bytes for hostRewrite.

    • getCredentialsProfile

      public String getCredentialsProfile()
       Specifies the credentials profile to be used from the AWS credentials file.
 This parameter is optional. If set, it will override the value set in the AWS_PROFILE env variable and
 the provider chain is limited to the AWS credentials file Provider.
 If credentials configuration is provided, this configuration will be ignored.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).
      string credentials_profile = 5;
      Specified by:
      getCredentialsProfile in interface ConfigOrBuilder
      Returns:
      The credentialsProfile.

    • getCredentialsProfileBytes

      public com.google.protobuf.ByteString getCredentialsProfileBytes()
       Specifies the credentials profile to be used from the AWS credentials file.
 This parameter is optional. If set, it will override the value set in the AWS_PROFILE env variable and
 the provider chain is limited to the AWS credentials file Provider.
 If credentials configuration is provided, this configuration will be ignored.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).
      string credentials_profile = 5;
      Specified by:
      getCredentialsProfileBytes in interface ConfigOrBuilder
      Returns:
      The bytes for credentialsProfile.

    • hasCredentials

      public boolean hasCredentials()
       Specifies the credentials to be used. This parameter is optional and if it is set,
 it will override other providers and will take precedence over credentials_profile.
 The provider chain is limited to the configuration credentials provider.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).

 .. warning::
   Distributing the AWS credentials via this configuration should not be done in production.
      .envoy.extensions.filters.http.aws_lambda.v3.Credentials credentials = 6;
      Specified by:
      hasCredentials in interface ConfigOrBuilder
      Returns:
      Whether the credentials field is set.

    • getCredentials

      public Credentials getCredentials()
       Specifies the credentials to be used. This parameter is optional and if it is set,
 it will override other providers and will take precedence over credentials_profile.
 The provider chain is limited to the configuration credentials provider.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).

 .. warning::
   Distributing the AWS credentials via this configuration should not be done in production.
      .envoy.extensions.filters.http.aws_lambda.v3.Credentials credentials = 6;
      Specified by:
      getCredentials in interface ConfigOrBuilder
      Returns:
      The credentials.

    • getCredentialsOrBuilder

      public CredentialsOrBuilder getCredentialsOrBuilder()
       Specifies the credentials to be used. This parameter is optional and if it is set,
 it will override other providers and will take precedence over credentials_profile.
 The provider chain is limited to the configuration credentials provider.
 If this field is provided, then the default providers chain specified in the documentation will be ignored.
 (See :ref:`default credentials providers <config_http_filters_aws_lambda_credentials>`).

 .. warning::
   Distributing the AWS credentials via this configuration should not be done in production.
      .envoy.extensions.filters.http.aws_lambda.v3.Credentials credentials = 6;
      Specified by:
      getCredentialsOrBuilder in interface ConfigOrBuilder

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Config parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Config.Builder newBuilder()

    • newBuilder

      public static Config.Builder newBuilder(Config prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Config getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Config> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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