Stage (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigatewayv2.model.Stage

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Represents an API stage.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Stage()

Constructors
Constructor and Description
`Stage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Stage`	`addRouteSettingsEntry(String key, RouteSettings value)` Add a single RouteSettings entry
`Stage`	`addStageVariablesEntry(String key, String value)` Add a single StageVariables entry
`Stage`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Stage`	`clearRouteSettingsEntries()` Removes all the entries added into RouteSettings.
`Stage`	`clearStageVariablesEntries()` Removes all the entries added into StageVariables.
`Stage`	`clearTagsEntries()` Removes all the entries added into Tags.
`Stage`	`clone()`
`boolean`	`equals(Object obj)`
`AccessLogSettings`	`getAccessLogSettings()` Settings for logging access in this stage.
`Boolean`	`getApiGatewayManaged()` Specifies whether a stage is managed by API Gateway.
`Boolean`	`getAutoDeploy()` Specifies whether updates to an API automatically trigger a new deployment.
`String`	`getClientCertificateId()` The identifier of a client certificate for a Stage.
`Date`	`getCreatedDate()` The timestamp when the stage was created.
`RouteSettings`	`getDefaultRouteSettings()` Default route settings for the stage.
`String`	`getDeploymentId()` The identifier of the Deployment that the Stage is associated with.
`String`	`getDescription()` The description of the stage.
`String`	`getLastDeploymentStatusMessage()` Describes the status of the last deployment of a stage.
`Date`	`getLastUpdatedDate()` The timestamp when the stage was last updated.
`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 resource.
`Map<String,String>`	`getTags()` The collection of tags.
`int`	`hashCode()`
`Boolean`	`isApiGatewayManaged()` Specifies whether a stage is managed by API Gateway.
`Boolean`	`isAutoDeploy()` Specifies whether updates to an API automatically trigger a new deployment.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessLogSettings(AccessLogSettings accessLogSettings)` Settings for logging access in this stage.
`void`	`setApiGatewayManaged(Boolean apiGatewayManaged)` Specifies whether a stage is managed by API Gateway.
`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`	`setCreatedDate(Date createdDate)` The timestamp when the stage was created.
`void`	`setDefaultRouteSettings(RouteSettings defaultRouteSettings)` Default route settings for the stage.
`void`	`setDeploymentId(String deploymentId)` The identifier of the Deployment that the Stage is associated with.
`void`	`setDescription(String description)` The description of the stage.
`void`	`setLastDeploymentStatusMessage(String lastDeploymentStatusMessage)` Describes the status of the last deployment of a stage.
`void`	`setLastUpdatedDate(Date lastUpdatedDate)` The timestamp when the stage was last updated.
`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 resource.
`void`	`setTags(Map<String,String> tags)` The collection of tags.
`String`	`toString()` Returns a string representation of this object.
`Stage`	`withAccessLogSettings(AccessLogSettings accessLogSettings)` Settings for logging access in this stage.
`Stage`	`withApiGatewayManaged(Boolean apiGatewayManaged)` Specifies whether a stage is managed by API Gateway.
`Stage`	`withAutoDeploy(Boolean autoDeploy)` Specifies whether updates to an API automatically trigger a new deployment.
`Stage`	`withClientCertificateId(String clientCertificateId)` The identifier of a client certificate for a Stage.
`Stage`	`withCreatedDate(Date createdDate)` The timestamp when the stage was created.
`Stage`	`withDefaultRouteSettings(RouteSettings defaultRouteSettings)` Default route settings for the stage.
`Stage`	`withDeploymentId(String deploymentId)` The identifier of the Deployment that the Stage is associated with.
`Stage`	`withDescription(String description)` The description of the stage.
`Stage`	`withLastDeploymentStatusMessage(String lastDeploymentStatusMessage)` Describes the status of the last deployment of a stage.
`Stage`	`withLastUpdatedDate(Date lastUpdatedDate)` The timestamp when the stage was last updated.
`Stage`	`withRouteSettings(Map<String,RouteSettings> routeSettings)` Route settings for the stage, by routeKey.
`Stage`	`withStageName(String stageName)` The name of the stage.
`Stage`	`withStageVariables(Map<String,String> stageVariables)` A map that defines the stage variables for a stage resource.
`Stage`	`withTags(Map<String,String> tags)` The collection of tags.

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

- Constructor Detail
  - Stage
```
public Stage()
```
- 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 Stage 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.
  - setApiGatewayManaged
```
public void setApiGatewayManaged(Boolean apiGatewayManaged)
```
    Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
    
    Parameters:
    
    apiGatewayManaged - Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
  - getApiGatewayManaged
```
public Boolean getApiGatewayManaged()
```
    Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
    
    Returns:
    
    Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
  - withApiGatewayManaged
```
public Stage withApiGatewayManaged(Boolean apiGatewayManaged)
```
    Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
    
    Parameters:
    
    apiGatewayManaged - Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isApiGatewayManaged
```
public Boolean isApiGatewayManaged()
```
    Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
    
    Returns:
    
    Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
  - 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 Stage 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 Stage 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.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The timestamp when the stage was created.
    
    Parameters:
    
    createdDate - The timestamp when the stage was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The timestamp when the stage was created.
    
    Returns:
    
    The timestamp when the stage was created.
  - withCreatedDate
```
public Stage withCreatedDate(Date createdDate)
```
    The timestamp when the stage was created.
    
    Parameters:
    
    createdDate - The timestamp when the stage was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultRouteSettings
```
public void setDefaultRouteSettings(RouteSettings defaultRouteSettings)
```
    Default route settings for the stage.
    
    Parameters:
    
    defaultRouteSettings - Default route settings for the stage.
  - getDefaultRouteSettings
```
public RouteSettings getDefaultRouteSettings()
```
    Default route settings for the stage.
    
    Returns:
    
    Default route settings for the stage.
  - withDefaultRouteSettings
```
public Stage withDefaultRouteSettings(RouteSettings defaultRouteSettings)
```
    Default route settings for the stage.
    
    Parameters:
    
    defaultRouteSettings - 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 identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
    
    Parameters:
    
    deploymentId - The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
  - getDeploymentId
```
public String getDeploymentId()
```
    The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
    
    Returns:
    
    The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
  - withDeploymentId
```
public Stage withDeploymentId(String deploymentId)
```
    The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
    
    Parameters:
    
    deploymentId - The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the stage.
    
    Parameters:
    
    description - The description of the stage.
  - getDescription
```
public String getDescription()
```
    The description of the stage.
    
    Returns:
    
    The description of the stage.
  - withDescription
```
public Stage withDescription(String description)
```
    The description of the stage.
    
    Parameters:
    
    description - The description of the stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastDeploymentStatusMessage
```
public void setLastDeploymentStatusMessage(String lastDeploymentStatusMessage)
```
    Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
    
    Parameters:
    
    lastDeploymentStatusMessage - Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
  - getLastDeploymentStatusMessage
```
public String getLastDeploymentStatusMessage()
```
    Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
    
    Returns:
    
    Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
  - withLastDeploymentStatusMessage
```
public Stage withLastDeploymentStatusMessage(String lastDeploymentStatusMessage)
```
    Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
    
    Parameters:
    
    lastDeploymentStatusMessage - Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDate
```
public void setLastUpdatedDate(Date lastUpdatedDate)
```
    The timestamp when the stage was last updated.
    
    Parameters:
    
    lastUpdatedDate - The timestamp when the stage was last updated.
  - getLastUpdatedDate
```
public Date getLastUpdatedDate()
```
    The timestamp when the stage was last updated.
    
    Returns:
    
    The timestamp when the stage was last updated.
  - withLastUpdatedDate
```
public Stage withLastUpdatedDate(Date lastUpdatedDate)
```
    The timestamp when the stage was last updated.
    
    Parameters:
    
    lastUpdatedDate - The timestamp when the stage was last updated.
    
    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 Stage 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 Stage 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 Stage 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 Stage 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 resource. 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 resource. 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 resource. 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 resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
  - withStageVariables
```
public Stage withStageVariables(Map<String,String> stageVariables)
```
    A map that defines the stage variables for a stage resource. 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 resource. 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 Stage addStageVariablesEntry(String key,
                                    String value)
```
    Add a single StageVariables entry
    
    See Also:
    
    withStageVariables(java.util.Map<java.lang.String, java.lang.String>)
  - clearStageVariablesEntries
```
public Stage 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 Stage 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 Stage addTagsEntry(String key,
                          String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Stage 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 Stage 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.

AWS SDK for Java 1.x API Reference - 1.12.773

Class Stage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Stage

Method Detail

setAccessLogSettings

getAccessLogSettings

withAccessLogSettings

setApiGatewayManaged

getApiGatewayManaged

withApiGatewayManaged

isApiGatewayManaged

setAutoDeploy

getAutoDeploy

withAutoDeploy

isAutoDeploy

setClientCertificateId

getClientCertificateId

withClientCertificateId

setCreatedDate

getCreatedDate

withCreatedDate

setDefaultRouteSettings

getDefaultRouteSettings

withDefaultRouteSettings

setDeploymentId

getDeploymentId

withDeploymentId

setDescription

getDescription

withDescription

setLastDeploymentStatusMessage

getLastDeploymentStatusMessage

withLastDeploymentStatusMessage

setLastUpdatedDate

getLastUpdatedDate

withLastUpdatedDate

getRouteSettings

setRouteSettings

withRouteSettings

addRouteSettingsEntry

clearRouteSettingsEntries

setStageName

getStageName

withStageName

getStageVariables

setStageVariables

withStageVariables

addStageVariablesEntry

clearStageVariablesEntries

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall