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

Class GetBasePathMappingRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetBasePathMappingRequest.Builder,GetBasePathMappingRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetBasePathMappingRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<GetBasePathMappingRequest.Builder,GetBasePathMappingRequest>

Request to describe a BasePathMapping resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetBasePathMappingRequest.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 GetBasePathMappingRequest.Builder	builder()
String	domainName()	The domain name of the BasePathMapping resource to be described.
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()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetBasePathMappingRequest.Builder>	serializableBuilderClass()
GetBasePathMappingRequest.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 be described.

Returns:

The domain name of the BasePathMapping resource to be described.

domainNameId

public final String domainNameId()

The identifier for the domain name resource. Supported only for private custom domain names.

Returns:

The identifier for the domain name resource. Supported only 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 any 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 any base path name after the domain name.

toBuilder

public GetBasePathMappingRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetBasePathMappingRequest.Builder,GetBasePathMappingRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static GetBasePathMappingRequest.Builder builder()

serializableBuilderClass

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