CreateStageRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.apigatewayv2.model.CreateStageRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateStageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Creates a new Stage resource to represent a stage.

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateStageRequest()

Constructors
Constructor and Description
`CreateStageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateStageRequest`	`addRouteSettingsEntry(String key, RouteSettings value)` Add a single RouteSettings entry
`CreateStageRequest`	`addStageVariablesEntry(String key, String value)` Add a single StageVariables entry
`CreateStageRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CreateStageRequest`	`clearRouteSettingsEntries()` Removes all the entries added into RouteSettings.
`CreateStageRequest`	`clearStageVariablesEntries()` Removes all the entries added into StageVariables.
`CreateStageRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreateStageRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`AccessLogSettings`	`getAccessLogSettings()` Settings for logging access in this stage.
`String`	`getApiId()` The API identifier.
`Boolean`	`getAutoDeploy()` Specifies whether updates to an API automatically trigger a new deployment.
`String`	`getClientCertificateId()` The identifier of a client certificate for a Stage.
`RouteSettings`	`getDefaultRouteSettings()` The default route settings for the stage.
`String`	`getDeploymentId()` The deployment identifier of the API stage.
`String`	`getDescription()` The description for the API stage.
`Map<String,RouteSettings>`	`getRouteSettings()` Route settings for the stage, by routeKey.
`String`	`getStageName()` The name of the stage.
`Map<String,String>`	`getStageVariables()` A map that defines the stage variables for a Stage.
`Map<String,String>`	`getTags()` The collection of tags.
`int`	`hashCode()`
`Boolean`	`isAutoDeploy()` Specifies whether updates to an API automatically trigger a new deployment.
`void`	`setAccessLogSettings(AccessLogSettings accessLogSettings)` Settings for logging access in this stage.
`void`	`setApiId(String apiId)` The API identifier.
`void`	`setAutoDeploy(Boolean autoDeploy)` Specifies whether updates to an API automatically trigger a new deployment.
`void`	`setClientCertificateId(String clientCertificateId)` The identifier of a client certificate for a Stage.
`void`	`setDefaultRouteSettings(RouteSettings defaultRouteSettings)` The default route settings for the stage.
`void`	`setDeploymentId(String deploymentId)` The deployment identifier of the API stage.
`void`	`setDescription(String description)` The description for the API stage.
`void`	`setRouteSettings(Map<String,RouteSettings> routeSettings)` Route settings for the stage, by routeKey.
`void`	`setStageName(String stageName)` The name of the stage.
`void`	`setStageVariables(Map<String,String> stageVariables)` A map that defines the stage variables for a Stage.
`void`	`setTags(Map<String,String> tags)` The collection of tags.
`String`	`toString()` Returns a string representation of this object.
`CreateStageRequest`	`withAccessLogSettings(AccessLogSettings accessLogSettings)` Settings for logging access in this stage.
`CreateStageRequest`	`withApiId(String apiId)` The API identifier.
`CreateStageRequest`	`withAutoDeploy(Boolean autoDeploy)` Specifies whether updates to an API automatically trigger a new deployment.
`CreateStageRequest`	`withClientCertificateId(String clientCertificateId)` The identifier of a client certificate for a Stage.
`CreateStageRequest`	`withDefaultRouteSettings(RouteSettings defaultRouteSettings)` The default route settings for the stage.
`CreateStageRequest`	`withDeploymentId(String deploymentId)` The deployment identifier of the API stage.
`CreateStageRequest`	`withDescription(String description)` The description for the API stage.
`CreateStageRequest`	`withRouteSettings(Map<String,RouteSettings> routeSettings)` Route settings for the stage, by routeKey.
`CreateStageRequest`	`withStageName(String stageName)` The name of the stage.
`CreateStageRequest`	`withStageVariables(Map<String,String> stageVariables)` A map that defines the stage variables for a Stage.
`CreateStageRequest`	`withTags(Map<String,String> tags)` The collection of tags.

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

- Constructor Detail
  - CreateStageRequest
```
public CreateStageRequest()
```
- Method Detail
  - setAccessLogSettings
```
public void setAccessLogSettings(AccessLogSettings accessLogSettings)
```
    Settings for logging access in this stage.
    
    Parameters:
    
    accessLogSettings - Settings for logging access in this stage.
  - getAccessLogSettings
```
public AccessLogSettings getAccessLogSettings()
```
    Settings for logging access in this stage.
    
    Returns:
    
    Settings for logging access in this stage.
  - withAccessLogSettings
```
public CreateStageRequest withAccessLogSettings(AccessLogSettings accessLogSettings)
```
    Settings for logging access in this stage.
    
    Parameters:
    
    accessLogSettings - Settings for logging access in this stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiId
```
public void setApiId(String apiId)
```
    The API identifier.
    
    Parameters:
    
    apiId - The API identifier.
  - getApiId
```
public String getApiId()
```
    The API identifier.
    
    Returns:
    
    The API identifier.
  - withApiId
```
public CreateStageRequest withApiId(String apiId)
```
    The API identifier.
    
    Parameters:
    
    apiId - The API identifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutoDeploy
```
public void setAutoDeploy(Boolean autoDeploy)
```
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    
    Parameters:
    
    autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
  - getAutoDeploy
```
public Boolean getAutoDeploy()
```
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    
    Returns:
    
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
  - withAutoDeploy
```
public CreateStageRequest withAutoDeploy(Boolean autoDeploy)
```
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    
    Parameters:
    
    autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAutoDeploy
```
public Boolean isAutoDeploy()
```
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    
    Returns:
    
    Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
  - setClientCertificateId
```
public void setClientCertificateId(String clientCertificateId)
```
    The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
    
    Parameters:
    
    clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
  - getClientCertificateId
```
public String getClientCertificateId()
```
    The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
    
    Returns:
    
    The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
  - withClientCertificateId
```
public CreateStageRequest withClientCertificateId(String clientCertificateId)
```
    The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
    
    Parameters:
    
    clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultRouteSettings
```
public void setDefaultRouteSettings(RouteSettings defaultRouteSettings)
```
    The default route settings for the stage.
    
    Parameters:
    
    defaultRouteSettings - The default route settings for the stage.
  - getDefaultRouteSettings
```
public RouteSettings getDefaultRouteSettings()
```
    The default route settings for the stage.
    
    Returns:
    
    The default route settings for the stage.
  - withDefaultRouteSettings
```
public CreateStageRequest withDefaultRouteSettings(RouteSettings defaultRouteSettings)
```
    The default route settings for the stage.
    
    Parameters:
    
    defaultRouteSettings - The default route settings for the stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeploymentId
```
public void setDeploymentId(String deploymentId)
```
    The deployment identifier of the API stage.
    
    Parameters:
    
    deploymentId - The deployment identifier of the API stage.
  - getDeploymentId
```
public String getDeploymentId()
```
    The deployment identifier of the API stage.
    
    Returns:
    
    The deployment identifier of the API stage.
  - withDeploymentId
```
public CreateStageRequest withDeploymentId(String deploymentId)
```
    The deployment identifier of the API stage.
    
    Parameters:
    
    deploymentId - The deployment identifier of the API stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for the API stage.
    
    Parameters:
    
    description - The description for the API stage.
  - getDescription
```
public String getDescription()
```
    The description for the API stage.
    
    Returns:
    
    The description for the API stage.
  - withDescription
```
public CreateStageRequest withDescription(String description)
```
    The description for the API stage.
    
    Parameters:
    
    description - The description for the API stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRouteSettings
```
public Map<String,RouteSettings> getRouteSettings()
```
    Route settings for the stage, by routeKey.
    
    Returns:
    
    Route settings for the stage, by routeKey.
  - setRouteSettings
```
public void setRouteSettings(Map<String,RouteSettings> routeSettings)
```
    Route settings for the stage, by routeKey.
    
    Parameters:
    
    routeSettings - Route settings for the stage, by routeKey.
  - withRouteSettings
```
public CreateStageRequest withRouteSettings(Map<String,RouteSettings> routeSettings)
```
    Route settings for the stage, by routeKey.
    
    Parameters:
    
    routeSettings - Route settings for the stage, by routeKey.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addRouteSettingsEntry
```
public CreateStageRequest addRouteSettingsEntry(String key,
                                                RouteSettings value)
```
    Add a single RouteSettings entry
    
    See Also:
    
    withRouteSettings(java.util.Map<java.lang.String, com.amazonaws.services.apigatewayv2.model.RouteSettings>)
  - clearRouteSettingsEntries
```
public CreateStageRequest clearRouteSettingsEntries()
```
    Removes all the entries added into RouteSettings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStageName
```
public void setStageName(String stageName)
```
    The name of the stage.
    
    Parameters:
    
    stageName - The name of the stage.
  - getStageName
```
public String getStageName()
```
    The name of the stage.
    
    Returns:
    
    The name of the stage.
  - withStageName
```
public CreateStageRequest withStageName(String stageName)
```
    The name of the stage.
    
    Parameters:
    
    stageName - The name of the stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStageVariables
```
public Map<String,String> getStageVariables()
```
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    
    Returns:
    
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
  - setStageVariables
```
public void setStageVariables(Map<String,String> stageVariables)
```
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    
    Parameters:
    
    stageVariables - A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
  - withStageVariables
```
public CreateStageRequest withStageVariables(Map<String,String> stageVariables)
```
    A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    
    Parameters:
    
    stageVariables - A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addStageVariablesEntry
```
public CreateStageRequest addStageVariablesEntry(String key,
                                                 String value)
```
    Add a single StageVariables entry
    
    See Also:
    
    withStageVariables(java.util.Map<java.lang.String, java.lang.String>)
  - clearStageVariablesEntries
```
public CreateStageRequest clearStageVariablesEntries()
```
    Removes all the entries added into StageVariables.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Parameters:
    
    tags - The collection of tags. Each tag element is associated with a given resource.
  - withTags
```
public CreateStageRequest withTags(Map<String,String> tags)
```
    The collection of tags. Each tag element is associated with a given resource.
    
    Parameters:
    
    tags - The collection of tags. Each tag element is associated with a given resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateStageRequest addTagsEntry(String key,
                                       String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateStageRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 CreateStageRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.780

Class CreateStageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateStageRequest

Method Detail

setAccessLogSettings

getAccessLogSettings

withAccessLogSettings

setApiId

getApiId

withApiId

setAutoDeploy

getAutoDeploy

withAutoDeploy

isAutoDeploy

setClientCertificateId

getClientCertificateId

withClientCertificateId

setDefaultRouteSettings

getDefaultRouteSettings

withDefaultRouteSettings

setDeploymentId

getDeploymentId

withDeploymentId

setDescription

getDescription

withDescription

getRouteSettings

setRouteSettings

withRouteSettings

addRouteSettingsEntry

clearRouteSettingsEntries

setStageName

getStageName

withStageName

getStageVariables

setStageVariables

withStageVariables

addStageVariablesEntry

clearStageVariablesEntries

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone