BasePathMapping (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.BasePathMapping

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BasePathMapping
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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

Constructor Summary

Constructors
Constructor and Description

BasePathMapping()

Constructors
Constructor and Description
`BasePathMapping()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BasePathMapping`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBasePath()` The base path name that callers of the API must provide as part of the URL after the domain name.
`String`	`getRestApiId()` The string identifier of the associated RestApi.
`String`	`getStage()` The name of the associated stage.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBasePath(String basePath)` The base path name that callers of the API must provide as part of the URL after the domain name.
`void`	`setRestApiId(String restApiId)` The string identifier of the associated RestApi.
`void`	`setStage(String stage)` The name of the associated stage.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`BasePathMapping`	`withBasePath(String basePath)` The base path name that callers of the API must provide as part of the URL after the domain name.
`BasePathMapping`	`withRestApiId(String restApiId)` The string identifier of the associated RestApi.
`BasePathMapping`	`withStage(String stage)` The name of the associated stage.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BasePathMapping
```
public BasePathMapping()
```
- Method Detail
  - setBasePath
```
public void setBasePath(String basePath)
```
    The base path name that callers of the API must provide as part of the URL after the domain name.
    
    Parameters:
    
    basePath - The base path name that callers of the API must provide as part of the URL after the domain name.
  - getBasePath
```
public String getBasePath()
```
    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.
  - withBasePath
```
public BasePathMapping withBasePath(String basePath)
```
    The base path name that callers of the API must provide as part of the URL after the domain name.
    
    Parameters:
    
    basePath - The base path name that callers of the API must provide as part of the URL after the domain name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRestApiId
```
public void setRestApiId(String restApiId)
```
    The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - The string identifier of the associated RestApi.
  - getRestApiId
```
public String getRestApiId()
```
    The string identifier of the associated RestApi.
    
    Returns:
    
    The string identifier of the associated RestApi.
  - withRestApiId
```
public BasePathMapping withRestApiId(String restApiId)
```
    The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - The string identifier of the associated RestApi.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStage
```
public void setStage(String stage)
```
    The name of the associated stage.
    
    Parameters:
    
    stage - The name of the associated stage.
  - getStage
```
public String getStage()
```
    The name of the associated stage.
    
    Returns:
    
    The name of the associated stage.
  - withStage
```
public BasePathMapping withStage(String stage)
```
    The name of the associated stage.
    
    Parameters:
    
    stage - The name of the associated stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BasePathMapping clone()
```
    Overrides:
    
    clone 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.

Did this page help you?

Class BasePathMapping

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasePathMapping

Method Detail

setBasePath

getBasePath

withBasePath

setRestApiId

getRestApiId

withRestApiId

setStage

getStage

withStage

toString

equals

hashCode

clone

marshall