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:

ToCopyableBuilder<GetBasePathMappingRequest.Builder,GetBasePathMappingRequest>

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

Request to describe a BasePathMapping resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetBasePathMappingRequest.Builder

Method Summary

Modifier and Type	Method and 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.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
static Class<? extends GetBasePathMappingRequest.Builder>	serializableBuilderClass()
GetBasePathMappingRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domainName

public String domainName()

The domain name of the BasePathMapping resource to be described.

Returns:

The domain name of the BasePathMapping resource to be described.

basePath

public 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. Leave this blank 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. Leave this blank if you do not want callers to specify any base path name after the domain name.

toBuilder

public GetBasePathMappingRequest.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<GetBasePathMappingRequest.Builder,GetBasePathMappingRequest>

Specified by:

toBuilder in class APIGatewayRequest

Returns:

a builder for type T

builder

public static GetBasePathMappingRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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