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

Class BasePathMapping

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<BasePathMapping.Builder,BasePathMapping>

@Generated("software.amazon.awssdk:codegen")
public class BasePathMapping
extends Object
implements StructuredPojo, 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BasePathMapping.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 BasePathMapping.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	restApiId()	The name of the API.
static Class<? extends BasePathMapping.Builder>	serializableBuilderClass()
String	stage()	The name of the API's 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

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 name of the API.

Returns:

The name of the API.

stage

public String stage()

The name of the API's stage.

Returns:

The name of the API's 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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.