Class CreateBasePathMappingRequest

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

Requests API Gateway to create a new BasePathMapping resource.

  • Method Details

    • domainName

      public final String domainName()

      The domain name of the BasePathMapping resource to create.

      Returns:
      The domain name of the BasePathMapping resource to create.

    • basePath

      public final String basePath()

      The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

      Returns:
      The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

    • restApiId

      public final String restApiId()

      The string identifier of the associated RestApi.

      Returns:
      The string identifier of the associated RestApi.

    • stage

      public final String stage()

      The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

      Returns:
      The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

    • toBuilder

      public CreateBasePathMappingRequest.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<CreateBasePathMappingRequest.Builder,CreateBasePathMappingRequest>
      Specified by:
      toBuilder in class ApiGatewayRequest
      Returns:
      a builder for type T

    • builder

      public static CreateBasePathMappingRequest.Builder builder()

    • serializableBuilderClass

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