software.amazon.awssdk.services.apigateway.model

Class BasePathMapping

java.lang.Object

software.amazon.awssdk.services.apigateway.model.BasePathMapping

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BasePathMapping.Builder,BasePathMapping>

@Generated(value="software.amazon.awssdk:codegen")
public final class BasePathMapping
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BasePathMapping.Builder,BasePathMapping>

Represents the base path that callers of the API must provide as part of the URL after the domain name.

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.

Use Custom Domain Names

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BasePathMapping.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 BasePathMapping.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	restApiId() The string identifier of the associated RestApi.
List<SdkField<?>>	sdkFields()
static Class<? extends BasePathMapping.Builder>	serializableBuilderClass()
String	stage() The name of the associated stage.
BasePathMapping.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

basePath

public String basePath()

The base path name that callers of the API must provide as part of the URL 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.

restApiId

public String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

stage

public String stage()

The name of the associated stage.

Returns:

The name of the associated stage.

toBuilder

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

Returns:

a builder for type T

builder

public static BasePathMapping.Builder builder()

serializableBuilderClass

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

sdkFields

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