Package software.amazon.awssdk.services.apigateway.model

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateBasePathMappingRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	basePath()	The base path name that callers of the API must provide as part of the URL after the domain name.
static CreateBasePathMappingRequest.Builder	builder()
String	domainName()	The domain name of the BasePathMapping resource to create.
String	domainNameId()	The identifier for the domain name resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	restApiId()	The string identifier of the associated RestApi.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBasePathMappingRequest.Builder>	serializableBuilderClass()
String	stage()	The name of the API's stage that you want to use for this mapping.
CreateBasePathMappingRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domainName

public final String domainName()

The domain name of the BasePathMapping resource to create.

Returns:

The domain name of the BasePathMapping resource to create.

domainNameId

public final String domainNameId()

The identifier for the domain name resource. Required for private custom domain names.

Returns:

The identifier for the domain name resource. Required for private custom domain names.

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

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBasePathMappingRequest.Builder,CreateBasePathMappingRequest>

Specified by:

toBuilder in class ApiGatewayRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo