Class EndpointConfig

java.lang.Object
software.amazon.awssdk.services.lambdaweb.model.EndpointConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EndpointConfig.Builder,EndpointConfig>
@Generated("software.amazon.awssdk:codegen") public final class EndpointConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EndpointConfig.Builder,EndpointConfig>

The configuration for a web function endpoint.

See Also:

  • Method Details

    • endpointName

      public final String endpointName()

      The name of the endpoint. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. 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 name of the endpoint. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. 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.

      Returns:
      A description of the endpoint.

    • endpointType

      public final EndpointType endpointType()

      The type of endpoint. Determines how traffic is served and routed across Regions.

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

      Returns:
      The type of endpoint. Determines how traffic is served and routed across Regions.
      See Also:

    • endpointTypeAsString

      public final String endpointTypeAsString()

      The type of endpoint. Determines how traffic is served and routed across Regions.

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

      Returns:
      The type of endpoint. Determines how traffic is served and routed across Regions.
      See Also:

    • authType

      public final AuthType authType()

      The authorization type for the endpoint.

      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.
      See Also:

    • authTypeAsString

      public final String authTypeAsString()

      The authorization type for the endpoint.

      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.
      See Also:

    • autoDeploymentMode

      public final AutoDeploymentMode autoDeploymentMode()

      The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled, and this default is returned in the response.

      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. If you don't specify a value, the default is Disabled, and this default is returned in the response.
      See Also:

    • autoDeploymentModeAsString

      public final String autoDeploymentModeAsString()

      The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled, and this default is returned in the response.

      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. If you don't specify a value, the default is Disabled, and this default is returned in the response.
      See Also:

    • hasRegions

      public final boolean hasRegions()
      For responses, this returns true if the service returned a value for the Regions 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.

    • regions

      public final List<String> regions()

      The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

      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 hasRegions() method.

      Returns:
      The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

    • scalingConfig

      public final ScalingConfig scalingConfig()

      The scaling configuration for the endpoint.

      Returns:
      The scaling configuration for the endpoint.

    • throttleConfig

      public final ThrottleConfig throttleConfig()

      The throttling configuration for the endpoint.

      Returns:
      The throttling configuration for the endpoint.

    • toBuilder

      public EndpointConfig.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<EndpointConfig.Builder,EndpointConfig>
      Returns:
      a builder for type T

    • builder

      public static EndpointConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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