Class UpdateWebFunctionEndpointRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lambdaweb.model.LambdaWebRequest
software.amazon.awssdk.services.lambdaweb.model.UpdateWebFunctionEndpointRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateWebFunctionEndpointRequest.Builder,UpdateWebFunctionEndpointRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateWebFunctionEndpointRequest extends LambdaWebRequest implements ToCopyableBuilder<UpdateWebFunctionEndpointRequest.Builder,UpdateWebFunctionEndpointRequest>

The request to update a web function endpoint.

  • Method Details

    • functionName

      public final String functionName()

      The web function.

      You can specify either of the following:

      • The function name, for example my-function.

      • The function ARN.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

      Returns:
      The web function.

      You can specify either of the following:

      • The function name, for example my-function.

      • The function ARN.

      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

    • endpointName

      public final String endpointName()

      The endpoint to update.

      You can specify either of the following:

      • The endpoint name, for example my-endpoint.

      • The endpoint ARN.

      The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

      Returns:
      The endpoint to update.

      You can specify either of the following:

      • The endpoint name, for example my-endpoint.

      • The endpoint ARN.

      The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

    • description

      public final String description()

      A description of the endpoint. Omit this field to keep the current description.

      Returns:
      A description of the endpoint. Omit this field to keep the current description.

    • authType

      public final AuthType authType()

      The authorization type for the endpoint. Omit this field to keep the current authorization type.

      Valid values:

      • ApplicationManaged – Your application handles authorization.

      • IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).

      If the service returns an enum value that is not available in the current SDK version, authType will return AuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().

      Returns:
      The authorization type for the endpoint. Omit this field to keep the current authorization type.

      Valid values:

      • ApplicationManaged – Your application handles authorization.

      • IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).

      See Also:

    • authTypeAsString

      public final String authTypeAsString()

      The authorization type for the endpoint. Omit this field to keep the current authorization type.

      Valid values:

      • ApplicationManaged – Your application handles authorization.

      • IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).

      If the service returns an enum value that is not available in the current SDK version, authType will return AuthType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().

      Returns:
      The authorization type for the endpoint. Omit this field to keep the current authorization type.

      Valid values:

      • ApplicationManaged – Your application handles authorization.

      • IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).

      See Also:

    • autoDeploymentMode

      public final AutoDeploymentMode autoDeploymentMode()

      The auto-deployment mode for the endpoint. Omit this field to keep the current auto-deployment mode.

      Valid values:

      • LatestRevision – The endpoint automatically serves the newest revision.

      • Disabled – Revision routing stays fixed until you change it.

      If the service returns an enum value that is not available in the current SDK version, autoDeploymentMode will return AutoDeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoDeploymentModeAsString().

      Returns:
      The auto-deployment mode for the endpoint. Omit this field to keep the current auto-deployment mode.

      Valid values:

      • LatestRevision – The endpoint automatically serves the newest revision.

      • Disabled – Revision routing stays fixed until you change it.

      See Also:

    • autoDeploymentModeAsString

      public final String autoDeploymentModeAsString()

      The auto-deployment mode for the endpoint. Omit this field to keep the current auto-deployment mode.

      Valid values:

      • LatestRevision – The endpoint automatically serves the newest revision.

      • Disabled – Revision routing stays fixed until you change it.

      If the service returns an enum value that is not available in the current SDK version, autoDeploymentMode will return AutoDeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoDeploymentModeAsString().

      Returns:
      The auto-deployment mode for the endpoint. Omit this field to keep the current auto-deployment mode.

      Valid values:

      • LatestRevision – The endpoint automatically serves the newest revision.

      • Disabled – Revision routing stays fixed until you change it.

      See Also:

    • hasRevisionWeights

      public final boolean hasRevisionWeights()
      For responses, this returns true if the service returned a value for the RevisionWeights property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • revisionWeights

      public final List<RevisionWeight> revisionWeights()

      A list of revision weights that determine how traffic is distributed across revisions.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRevisionWeights() method.

      Returns:
      A list of revision weights that determine how traffic is distributed across revisions.

    • scalingConfig

      public final ScalingConfig scalingConfig()

      The scaling configuration for the endpoint. Omit this field to keep the current scaling configuration. To clear a previously set maxEnvironments value, specify an empty object.

      Returns:
      The scaling configuration for the endpoint. Omit this field to keep the current scaling configuration. To clear a previously set maxEnvironments value, specify an empty object.

    • throttleConfig

      public final ThrottleConfig throttleConfig()

      The throttling configuration for the endpoint. Omit this field to keep the current throttling configuration. To clear a previously set rateLimit value, specify an empty object.

      Returns:
      The throttling configuration for the endpoint. Omit this field to keep the current throttling configuration. To clear a previously set rateLimit value, specify an empty object.

    • toBuilder

      public UpdateWebFunctionEndpointRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateWebFunctionEndpointRequest.Builder,UpdateWebFunctionEndpointRequest>
      Specified by:
      toBuilder in class LambdaWebRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateWebFunctionEndpointRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateWebFunctionEndpointRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.