Class ApiGatewayProxyConfig

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

A wrapper object holding the Amazon API Gateway proxy configuration.

See Also:

  • Method Details

    • apiGatewayId

      public final String apiGatewayId()

      The resource ID of the API Gateway for the proxy.

      Returns:
      The resource ID of the API Gateway for the proxy.

    • endpointType

      public final ApiGatewayEndpointType endpointType()

      The type of API Gateway endpoint created.

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

      Returns:
      The type of API Gateway endpoint created.
      See Also:

    • endpointTypeAsString

      public final String endpointTypeAsString()

      The type of API Gateway endpoint created.

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

      Returns:
      The type of API Gateway endpoint created.
      See Also:

    • nlbArn

      public final String nlbArn()

      The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

      Returns:
      The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

    • nlbName

      public final String nlbName()

      The name of the Network Load Balancer that is configured by the API Gateway proxy.

      Returns:
      The name of the Network Load Balancer that is configured by the API Gateway proxy.

    • proxyUrl

      public final String proxyUrl()

      The endpoint URL of the API Gateway proxy.

      Returns:
      The endpoint URL of the API Gateway proxy.

    • stageName

      public final String stageName()

      The name of the API Gateway stage. The name defaults to prod.

      Returns:
      The name of the API Gateway stage. The name defaults to prod.

    • vpcLinkId

      public final String vpcLinkId()

      The VpcLink ID of the API Gateway proxy.

      Returns:
      The VpcLink ID of the API Gateway proxy.

    • toBuilder

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

    • builder

      public static ApiGatewayProxyConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ApiGatewayProxyConfig.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.